diff --git a/.docs/md/version_changes.md b/.docs/md/version_changes.md index 95083ddb94..df592b4782 100644 --- a/.docs/md/version_changes.md +++ b/.docs/md/version_changes.md @@ -1,4 +1,33 @@ # Changelog +### Version 3.9.3 + +#### New features + +* [feat(modeltime)](https://github.com/modflowpy/flopy/commit/932bdcc8c07a10148cf733c02ba9190167239066): Add from_headers and reverse methods (#2481). Committed by wpbonelli on 2025-03-29. +* [feat](https://github.com/modflowpy/flopy/commit/d8048a868b51d75039f0c3c097429144c6d44714): Add the angldegx to the kw dictionary produced by the get_disu_kwargs method (#2484). Committed by Sunny Titus on 2025-04-14. + +#### Bug fixes + +* [fix(resolve_exe)](https://github.com/modflowpy/flopy/commit/ca3adb34031285bc795b58fa42c4965d67278adc): Typecast exe name to string before passing to _resolve (#2457). Committed by martclanor on 2025-02-20. +* [fix(HeadFile,CellBudgetFile)](https://github.com/modflowpy/flopy/commit/39d8d32625151979d78b82e709fa46ca4f5f7d9f): Fix tdis reversal (#2460). Committed by wpbonelli on 2025-02-25. +* [fix(output_util.py)](https://github.com/modflowpy/flopy/commit/61e52f03ff69ec50b03a17c863738ad4a3c1dc4b): Trap grb in MF6Output (#2468). Committed by wpbonelli on 2025-03-07. +* [fix(binaryfile)](https://github.com/modflowpy/flopy/commit/02ab7f1ff18a5c03f06d98fe1b35d6d6f7ad12df): Tdis in head/budget reversal methods (#2475). Committed by wpbonelli on 2025-03-18. +* [fix(binaryfile)](https://github.com/modflowpy/flopy/commit/0eba4babad994a7cd73a3853714b9ff3bb326c90): Fix head/budget file reversal (#2483). Committed by wpbonelli on 2025-04-01. +* [fix(flopy/utils/sfroutputfile.py::SfrFile.get_results)](https://github.com/modflowpy/flopy/commit/bf02be00ded034d2765948c7d7b075bf9d6ed4f1): Refactor deprecated DataFrame.append() call to pandas.concat() (#2491). Committed by aleaf on 2025-04-21. +* [fix(model_splitter.py)](https://github.com/modflowpy/flopy/commit/838b37cc999c713aa7e71c4215f7535c5c9df27b): Add trap for obs packages in bc packages (#2493). Committed by Joshua Larsen on 2025-04-22. +* [fix(evt)](https://github.com/modflowpy/flopy/commit/dcba9cf5ca1d8b946b568748f713a6dcf21e2bc3): Optional field mishandling (#2490). Committed by mjreno on 2025-04-23. +* [fix](https://github.com/modflowpy/flopy/commit/0d9c91489a6a9df2c2c51c962e59cb5e9dd4ff2b): Update numpy array comparisons to use isin (#2504). Committed by Emmanuel Ferdman on 2025-05-06. +* [fix(column lengths)](https://github.com/modflowpy/flopy/commit/351c5b72401b5de52d230ef9f0897f58e4edf475): Autoscale array write to ncol for structured multi-model simulations (#2507). Committed by Joshua Larsen on 2025-05-12. + +#### Refactoring + +* [refactor(resolve_exe)](https://github.com/modflowpy/flopy/commit/c61643fd8d61e6e4866527104324a6c468eb0e41): Also fix tests (#2464). Committed by Mike Taves on 2025-03-03. +* [refactor(createpackages)](https://github.com/modflowpy/flopy/commit/c5b5a41f626ad24d8f0e564a83ab8dc673cc9b7b): Use jinja for mf6 module code generation (#2333). Committed by wpbonelli on 2025-03-07. +* [refactor(Mf6Splitter)](https://github.com/modflowpy/flopy/commit/20829b704b20be5175119fcd685fe808c55d51b6): Change how node mapping is stored and loaded (#2465). Committed by Joshua Larsen on 2025-03-14. +* [refactor(gridutil)](https://github.com/modflowpy/flopy/commit/48f46fb87a1a23bc13a41be881f3852fdab7d682): Improve arg handling in get_disu_kwargs (#2480). Committed by wpbonelli on 2025-04-01. +* [refactor(model_splitter.py)](https://github.com/modflowpy/flopy/commit/14640530dd46598d8d76417b6b640db0850cbf80): Support for SSM and ATS (#2505). Committed by Joshua Larsen on 2025-05-08. +* [refactor(codegen)](https://github.com/modflowpy/flopy/commit/69f6e09a8bea004454e9a83b76e5b37f8c0a7810): Move dfn utils from devtools (#2508). Committed by wpbonelli on 2025-05-13. + ### Version 3.9.2 #### New features diff --git a/CITATION.cff b/CITATION.cff index 65625b9cef..161b941b1e 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -3,8 +3,8 @@ message: If you use this software, please cite both the article from preferred-c references, and the software itself. type: software title: FloPy -version: 3.10.0.dev2 -date-released: '2025-02-12' +version: 3.10.0.dev3 +date-released: '2025-05-13' doi: 10.5066/F7BK19FH abstract: A Python package to create, run, and post-process MODFLOW-based models. repository-artifact: https://pypi.org/project/flopy diff --git a/README.md b/README.md index ab899b8e97..fddf5e8858 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ flopy3 -### Version 3.10.0.dev2 +### Version 3.10.0.dev3 [![flopy continuous integration](https://github.com/modflowpy/flopy/actions/workflows/commit.yml/badge.svg?branch=develop)](https://github.com/modflowpy/flopy/actions/workflows/commit.yml) [![Read the Docs](https://github.com/modflowpy/flopy/actions/workflows/rtd.yml/badge.svg?branch=develop)](https://github.com/modflowpy/flopy/actions/workflows/rtd.yml) @@ -150,7 +150,7 @@ How to Cite ##### ***Software/Code citation for FloPy:*** -[Bakker, Mark, Post, Vincent, Hughes, J. D., Langevin, C. D., White, J. T., Leaf, A. T., Paulinski, S. R., Bellino, J. C., Morway, E. D., Toews, M. W., Larsen, J. D., Fienen, M. N., Starn, J. J., Brakenhoff, D. A., and Bonelli, W. P., 2025, FloPy v3.10.0.dev2: U.S. Geological Survey Software Release, 12 February 2025, https://doi.org/10.5066/F7BK19FH](https://doi.org/10.5066/F7BK19FH) +[Bakker, Mark, Post, Vincent, Hughes, J. D., Langevin, C. D., White, J. T., Leaf, A. T., Paulinski, S. R., Bellino, J. C., Morway, E. D., Toews, M. W., Larsen, J. D., Fienen, M. N., Starn, J. J., Brakenhoff, D. A., and Bonelli, W. P., 2025, FloPy v3.10.0.dev3: U.S. Geological Survey Software Release, 13 May 2025, https://doi.org/10.5066/F7BK19FH](https://doi.org/10.5066/F7BK19FH) Additional FloPy Related Publications diff --git a/docs/PyPI_release.md b/docs/PyPI_release.md index 9cdfa7d70d..2df8083ac3 100644 --- a/docs/PyPI_release.md +++ b/docs/PyPI_release.md @@ -30,4 +30,4 @@ How to Cite *Software/Code citation for FloPy:* -[Bakker, Mark, Post, Vincent, Hughes, J. D., Langevin, C. D., White, J. T., Leaf, A. T., Paulinski, S. R., Bellino, J. C., Morway, E. D., Toews, M. W., Larsen, J. D., Fienen, M. N., Starn, J. J., Brakenhoff, D. A., and Bonelli, W. P., 2025, FloPy v3.10.0.dev2: U.S. Geological Survey Software Release, 12 February 2025, https://doi.org/10.5066/F7BK19FH](https://doi.org/10.5066/F7BK19FH) +[Bakker, Mark, Post, Vincent, Hughes, J. D., Langevin, C. D., White, J. T., Leaf, A. T., Paulinski, S. R., Bellino, J. C., Morway, E. D., Toews, M. W., Larsen, J. D., Fienen, M. N., Starn, J. J., Brakenhoff, D. A., and Bonelli, W. P., 2025, FloPy v3.10.0.dev3: U.S. Geological Survey Software Release, 13 May 2025, https://doi.org/10.5066/F7BK19FH](https://doi.org/10.5066/F7BK19FH) diff --git a/flopy/mf6/data/dfn/gwe-dis.dfn b/flopy/mf6/data/dfn/gwe-dis.dfn index f38d8434cf..7782455e67 100644 --- a/flopy/mf6/data/dfn/gwe-dis.dfn +++ b/flopy/mf6/data/dfn/gwe-dis.dfn @@ -17,6 +17,48 @@ optional true longname do not write binary grid file description keyword to deactivate writing of the binary grid file. +block options +name grb_filerecord +type record grb6 fileout grb6_filename +reader urword +tagged true +optional true +longname +description + +block options +name grb6 +type keyword +in_record true +reader urword +tagged true +optional false +longname grb keyword +description keyword to specify that record corresponds to a binary grid file. +extended true + +block options +name fileout +type keyword +in_record true +reader urword +tagged true +optional false +longname file keyword +description keyword to specify that an output filename is expected next. + +block options +name grb6_filename +type string +preserve_case true +in_record true +reader urword +optional false +tagged false +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''. +extended true + block options name xorigin type double precision diff --git a/flopy/mf6/data/dfn/gwe-disu.dfn b/flopy/mf6/data/dfn/gwe-disu.dfn index 1b2035600a..99666e5c59 100644 --- a/flopy/mf6/data/dfn/gwe-disu.dfn +++ b/flopy/mf6/data/dfn/gwe-disu.dfn @@ -16,6 +16,48 @@ optional true longname do not write binary grid file description keyword to deactivate writing of the binary grid file. +block options +name grb_filerecord +type record grb6 fileout grb6_filename +reader urword +tagged true +optional true +longname +description + +block options +name grb6 +type keyword +in_record true +reader urword +tagged true +optional false +longname grb keyword +description keyword to specify that record corresponds to a binary grid file. +extended true + +block options +name fileout +type keyword +in_record true +reader urword +tagged true +optional false +longname file keyword +description keyword to specify that an output filename is expected next. + +block options +name grb6_filename +type string +preserve_case true +in_record true +reader urword +optional false +tagged false +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''. +extended true + block options name xorigin type double precision diff --git a/flopy/mf6/data/dfn/gwe-disv.dfn b/flopy/mf6/data/dfn/gwe-disv.dfn index 85d95504c0..760d14b620 100644 --- a/flopy/mf6/data/dfn/gwe-disv.dfn +++ b/flopy/mf6/data/dfn/gwe-disv.dfn @@ -17,6 +17,48 @@ optional true longname do not write binary grid file description keyword to deactivate writing of the binary grid file. +block options +name grb_filerecord +type record grb6 fileout grb6_filename +reader urword +tagged true +optional true +longname +description + +block options +name grb6 +type keyword +in_record true +reader urword +tagged true +optional false +longname grb keyword +description keyword to specify that record corresponds to a binary grid file. +extended true + +block options +name fileout +type keyword +in_record true +reader urword +tagged true +optional false +longname file keyword +description keyword to specify that an output filename is expected next. + +block options +name grb6_filename +type string +preserve_case true +in_record true +reader urword +optional false +tagged false +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''. +extended true + block options name xorigin type double precision diff --git a/flopy/mf6/data/dfn/gwf-buy.dfn b/flopy/mf6/data/dfn/gwf-buy.dfn index 54a5d1b8f1..48b87c2085 100644 --- a/flopy/mf6/data/dfn/gwf-buy.dfn +++ b/flopy/mf6/data/dfn/gwf-buy.dfn @@ -131,7 +131,7 @@ tagged false shape reader urword longname modelname -description name of GWT 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 model that corresponds to this GWF model. +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. block packagedata name auxspeciesname diff --git a/flopy/mf6/data/dfn/gwf-dis.dfn b/flopy/mf6/data/dfn/gwf-dis.dfn index dd00ba0c24..4393881b2a 100644 --- a/flopy/mf6/data/dfn/gwf-dis.dfn +++ b/flopy/mf6/data/dfn/gwf-dis.dfn @@ -17,6 +17,48 @@ optional true longname do not write binary grid file description keyword to deactivate writing of the binary grid file. +block options +name grb_filerecord +type record grb6 fileout grb6_filename +reader urword +tagged true +optional true +longname +description + +block options +name grb6 +type keyword +in_record true +reader urword +tagged true +optional false +longname grb keyword +description keyword to specify that record corresponds to a binary grid file. +extended true + +block options +name fileout +type keyword +in_record true +reader urword +tagged true +optional false +longname file keyword +description keyword to specify that an output filename is expected next. + +block options +name grb6_filename +type string +preserve_case true +in_record true +reader urword +optional false +tagged false +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''. +extended true + block options name xorigin type double precision diff --git a/flopy/mf6/data/dfn/gwf-disu.dfn b/flopy/mf6/data/dfn/gwf-disu.dfn index be7be430a6..5af2969421 100644 --- a/flopy/mf6/data/dfn/gwf-disu.dfn +++ b/flopy/mf6/data/dfn/gwf-disu.dfn @@ -16,6 +16,48 @@ optional true longname do not write binary grid file description keyword to deactivate writing of the binary grid file. +block options +name grb_filerecord +type record grb6 fileout grb6_filename +reader urword +tagged true +optional true +longname +description + +block options +name grb6 +type keyword +in_record true +reader urword +tagged true +optional false +longname grb keyword +description keyword to specify that record corresponds to a binary grid file. +extended true + +block options +name fileout +type keyword +in_record true +reader urword +tagged true +optional false +longname file keyword +description keyword to specify that an output filename is expected next. + +block options +name grb6_filename +type string +preserve_case true +in_record true +reader urword +optional false +tagged false +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''. +extended true + block options name xorigin type double precision diff --git a/flopy/mf6/data/dfn/gwf-disv.dfn b/flopy/mf6/data/dfn/gwf-disv.dfn index 1d3aea3803..e0661de5e2 100644 --- a/flopy/mf6/data/dfn/gwf-disv.dfn +++ b/flopy/mf6/data/dfn/gwf-disv.dfn @@ -17,6 +17,48 @@ optional true longname do not write binary grid file description keyword to deactivate writing of the binary grid file. +block options +name grb_filerecord +type record grb6 fileout grb6_filename +reader urword +tagged true +optional true +longname +description + +block options +name grb6 +type keyword +in_record true +reader urword +tagged true +optional false +longname grb keyword +description keyword to specify that record corresponds to a binary grid file. +extended true + +block options +name fileout +type keyword +in_record true +reader urword +tagged true +optional false +longname file keyword +description keyword to specify that an output filename is expected next. + +block options +name grb6_filename +type string +preserve_case true +in_record true +reader urword +optional false +tagged false +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''. +extended true + block options name xorigin type double precision diff --git a/flopy/mf6/data/dfn/gwf-maw.dfn b/flopy/mf6/data/dfn/gwf-maw.dfn index 936182795b..ea3cb2a151 100644 --- a/flopy/mf6/data/dfn/gwf-maw.dfn +++ b/flopy/mf6/data/dfn/gwf-maw.dfn @@ -370,7 +370,7 @@ tagged false in_record true reader urword longname well bottom -description bottom elevation of the multi-aquifer well. If CONDEQN is SPECIFIED, THIEM, SKIN, or COMPOSITE, 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. +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. block packagedata name strt @@ -475,7 +475,7 @@ tagged false in_record true reader urword 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 COMPOSITE, 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. +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. block connectiondata name scrn_bot @@ -485,7 +485,7 @@ tagged false in_record true reader urword 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 COMPOSITE, 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. +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. block connectiondata name hk_skin diff --git a/flopy/mf6/data/dfn/gwf-vsc.dfn b/flopy/mf6/data/dfn/gwf-vsc.dfn index 0a6e74b9d1..ef3f85b73b 100644 --- a/flopy/mf6/data/dfn/gwf-vsc.dfn +++ b/flopy/mf6/data/dfn/gwf-vsc.dfn @@ -160,7 +160,7 @@ tagged false shape reader urword longname modelname -description name of a GWT 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 model that corresponds to this GWF model. +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. block packagedata name auxspeciesname diff --git a/flopy/mf6/data/dfn/gwt-dis.dfn b/flopy/mf6/data/dfn/gwt-dis.dfn index c19307cb82..c575a9c615 100644 --- a/flopy/mf6/data/dfn/gwt-dis.dfn +++ b/flopy/mf6/data/dfn/gwt-dis.dfn @@ -17,6 +17,48 @@ optional true longname do not write binary grid file description keyword to deactivate writing of the binary grid file. +block options +name grb_filerecord +type record grb6 fileout grb6_filename +reader urword +tagged true +optional true +longname +description + +block options +name grb6 +type keyword +in_record true +reader urword +tagged true +optional false +longname grb keyword +description keyword to specify that record corresponds to a binary grid file. +extended true + +block options +name fileout +type keyword +in_record true +reader urword +tagged true +optional false +longname file keyword +description keyword to specify that an output filename is expected next. + +block options +name grb6_filename +type string +preserve_case true +in_record true +reader urword +optional false +tagged false +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''. +extended true + block options name xorigin type double precision diff --git a/flopy/mf6/data/dfn/gwt-disu.dfn b/flopy/mf6/data/dfn/gwt-disu.dfn index 49fd5aa5ea..b56890a305 100644 --- a/flopy/mf6/data/dfn/gwt-disu.dfn +++ b/flopy/mf6/data/dfn/gwt-disu.dfn @@ -16,6 +16,48 @@ optional true longname do not write binary grid file description keyword to deactivate writing of the binary grid file. +block options +name grb_filerecord +type record grb6 fileout grb6_filename +reader urword +tagged true +optional true +longname +description + +block options +name grb6 +type keyword +in_record true +reader urword +tagged true +optional false +longname grb keyword +description keyword to specify that record corresponds to a binary grid file. +extended true + +block options +name fileout +type keyword +in_record true +reader urword +tagged true +optional false +longname file keyword +description keyword to specify that an output filename is expected next. + +block options +name grb6_filename +type string +preserve_case true +in_record true +reader urword +optional false +tagged false +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''. +extended true + block options name xorigin type double precision diff --git a/flopy/mf6/data/dfn/gwt-disv.dfn b/flopy/mf6/data/dfn/gwt-disv.dfn index dc9b8d0a03..21eb42d29a 100644 --- a/flopy/mf6/data/dfn/gwt-disv.dfn +++ b/flopy/mf6/data/dfn/gwt-disv.dfn @@ -17,6 +17,48 @@ optional true longname do not write binary grid file description keyword to deactivate writing of the binary grid file. +block options +name grb_filerecord +type record grb6 fileout grb6_filename +reader urword +tagged true +optional true +longname +description + +block options +name grb6 +type keyword +in_record true +reader urword +tagged true +optional false +longname grb keyword +description keyword to specify that record corresponds to a binary grid file. +extended true + +block options +name fileout +type keyword +in_record true +reader urword +tagged true +optional false +longname file keyword +description keyword to specify that an output filename is expected next. + +block options +name grb6_filename +type string +preserve_case true +in_record true +reader urword +optional false +tagged false +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''. +extended true + block options name xorigin type double precision diff --git a/flopy/mf6/data/dfn/prt-dis.dfn b/flopy/mf6/data/dfn/prt-dis.dfn index fc0a566999..df7ce86e51 100644 --- a/flopy/mf6/data/dfn/prt-dis.dfn +++ b/flopy/mf6/data/dfn/prt-dis.dfn @@ -16,6 +16,48 @@ optional true longname do not write binary grid file description keyword to deactivate writing of the binary grid file. +block options +name grb_filerecord +type record grb6 fileout grb6_filename +reader urword +tagged true +optional true +longname +description + +block options +name grb6 +type keyword +in_record true +reader urword +tagged true +optional false +longname grb keyword +description keyword to specify that record corresponds to a binary grid file. +extended true + +block options +name fileout +type keyword +in_record true +reader urword +tagged true +optional false +longname file keyword +description keyword to specify that an output filename is expected next. + +block options +name grb6_filename +type string +preserve_case true +in_record true +reader urword +optional false +tagged false +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''. +extended true + block options name xorigin type double precision diff --git a/flopy/mf6/data/dfn/prt-disv.dfn b/flopy/mf6/data/dfn/prt-disv.dfn index 540d70a016..29c64f4492 100644 --- a/flopy/mf6/data/dfn/prt-disv.dfn +++ b/flopy/mf6/data/dfn/prt-disv.dfn @@ -16,6 +16,48 @@ optional true longname do not write binary grid file description keyword to deactivate writing of the binary grid file. +block options +name grb_filerecord +type record grb6 fileout grb6_filename +reader urword +tagged true +optional true +longname +description + +block options +name grb6 +type keyword +in_record true +reader urword +tagged true +optional false +longname grb keyword +description keyword to specify that record corresponds to a binary grid file. +extended true + +block options +name fileout +type keyword +in_record true +reader urword +tagged true +optional false +longname file keyword +description keyword to specify that an output filename is expected next. If this option is not provided, the output file will have the same name as the discretization input file, plus extension ``.grb''. + +block options +name grb6_filename +type string +preserve_case true +in_record true +reader urword +optional false +tagged false +longname file name of GRB information +description defines a binary grid output file. +extended true + block options name xorigin type double precision diff --git a/flopy/mf6/data/dfn/prt-oc.dfn b/flopy/mf6/data/dfn/prt-oc.dfn index d946d112c4..68cd6f4938 100644 --- a/flopy/mf6/data/dfn/prt-oc.dfn +++ b/flopy/mf6/data/dfn/prt-oc.dfn @@ -191,6 +191,75 @@ optional true longname track usertime 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. +block options +name track_timesrecord +type record track_times times +shape +reader urword +tagged true +optional true +longname +description +removed 6.6.1 + +block options +name track_times +type keyword +reader urword +in_record true +tagged true +shape +longname +description keyword indicating tracking times will follow +removed 6.6.1 + +block options +name times +type double precision +shape (unknown) +reader urword +in_record true +tagged false +repeating true +longname tracking times +description times to track, relative to the beginning of the simulation. +removed 6.6.1 + +block options +name track_timesfilerecord +type record track_timesfile timesfile +shape +reader urword +tagged true +optional true +longname +description +removed 6.6.1 + +block options +name track_timesfile +type keyword +reader urword +in_record true +tagged true +shape +longname +description keyword indicating tracking times file name will follow +removed 6.6.1 + +block options +name timesfile +type string +preserve_case true +shape +in_record true +reader urword +tagged false +optional false +longname file keyword +description name of the tracking times file +removed 6.6.1 + # --------------------- prt oc dimensions ------------------ block dimensions diff --git a/flopy/mf6/data/dfn/prt-prp.dfn b/flopy/mf6/data/dfn/prt-prp.dfn index a7ce258aeb..25670944b3 100644 --- a/flopy/mf6/data/dfn/prt-prp.dfn +++ b/flopy/mf6/data/dfn/prt-prp.dfn @@ -168,6 +168,75 @@ optional true 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. +block options +name release_timesrecord +type record release_times times +shape +reader urword +tagged true +optional true +longname +description +removed 6.6.1 + +block options +name release_times +type keyword +reader urword +in_record true +tagged true +shape +longname +description keyword indicating release times will follow +removed 6.6.1 + +block options +name times +type double precision +shape (unknown) +reader urword +in_record true +tagged false +repeating true +longname release times +description times to release, relative to the beginning of the simulation. RELEASE\_TIMES and RELEASE\_TIMESFILE are mutually exclusive. +removed 6.6.1 + +block options +name release_timesfilerecord +type record release_timesfile timesfile +shape +reader urword +tagged true +optional true +longname +description +removed 6.6.1 + +block options +name release_timesfile +type keyword +reader urword +in_record true +tagged true +shape +longname +description keyword indicating release times file name will follow +removed 6.6.1 + +block options +name timesfile +type string +preserve_case true +shape +in_record true +reader urword +tagged false +optional false +longname file keyword +description name of the release times file. RELEASE\_TIMES and RELEASE\_TIMESFILE are mutually exclusive. +removed 6.6.1 + block options name dry_tracking_method type string diff --git a/flopy/mf6/data/dfn/toml/exg-gwegwe.toml b/flopy/mf6/data/dfn/toml/exg-gwegwe.toml new file mode 100644 index 0000000000..874a541065 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/exg-gwegwe.toml @@ -0,0 +1,253 @@ +name = "exg-gwegwe" +advanced = false +multi = true + +[fkeys.mve_filerecord] +parent = "parent_model_or_package" +key = "mve_filerecord" +val = "perioddata" +abbr = "mve" +param = "perioddata" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.gwfmodelname1] +block = "options" +name = "gwfmodelname1" +type = "string" +reader = "urword" +optional = false +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." + +[options.gwfmodelname2] +block = "options" +name = "gwfmodelname2" +type = "string" +reader = "urword" +optional = false +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." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of gwe exchange cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprpak" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "ipakcb" + +[options.adv_scheme] +block = "options" +name = "adv_scheme" +type = "string" +reader = "urword" +optional = true +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." +valid = "upstream central tvd" + +[options.cnd_xt3d_off] +block = "options" +name = "cnd_xt3d_off" +type = "keyword" +reader = "urword" +optional = true +longname = "deactivate xt3d" +description = "deactivate the xt3d method for the dispersive flux and use the faster and less accurate approximation for this exchange." + +[options.cnd_xt3d_rhs] +block = "options" +name = "cnd_xt3d_rhs" +type = "keyword" +reader = "urword" +optional = true +longname = "xt3d on right-hand side" +description = "add xt3d dispersion terms to right-hand side, when possible, for this exchange." + +[options.perioddata] +block = "options" +name = "perioddata" +type = "record mve6 filein mve6_filename" +reader = "urword" +optional = true +description = "Contains data for the mve package. Data can be passed as a dictionary to the mve package with variable names as keys and package data as values. Data for the perioddata variable is also acceptable. See mve package documentation for more information." + +[options.perioddata.ref] +parent = "parent_model_or_package" +key = "mve_filerecord" +val = "perioddata" +abbr = "mve" +param = "perioddata" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.dev_interfacemodel_on] +block = "options" +name = "dev_interfacemodel_on" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "dev_ifmod_on" + +[dimensions.nexg] +block = "dimensions" +name = "nexg" +type = "integer" +reader = "urword" +optional = false +longname = "number of exchanges" +description = "keyword and integer value specifying the number of gwe-gwe exchanges." + +[exchangedata.exchangedata] +block = "exchangedata" +name = "exchangedata" +type = "list" +shape = "(nexg)" +reader = "urword" +optional = false +longname = "exchange data" + +[exchangedata.exchangedata.item] +name = "exchangedata" +type = "record" +block = "exchangedata" +reader = "urword" +optional = false +longname = "exchange data" + +[exchangedata.exchangedata.item.fields.cellidm1] +block = "exchangedata" +name = "cellidm1" +type = "integer" +reader = "urword" +optional = "false" +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." +numeric_index = "true" + +[exchangedata.exchangedata.item.fields.cellidm2] +block = "exchangedata" +name = "cellidm2" +type = "integer" +reader = "urword" +optional = "false" +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." +numeric_index = "true" + +[exchangedata.exchangedata.item.fields.ihc] +block = "exchangedata" +name = "ihc" +type = "integer" +reader = "urword" +optional = "false" +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." + +[exchangedata.exchangedata.item.fields.cl1] +block = "exchangedata" +name = "cl1" +type = "double precision" +reader = "urword" +optional = "false" +longname = "connection distance" +description = "is the distance between the center of cell 1 and the its shared face with cell 2." + +[exchangedata.exchangedata.item.fields.cl2] +block = "exchangedata" +name = "cl2" +type = "double precision" +reader = "urword" +optional = "false" +longname = "connection distance" +description = "is the distance between the center of cell 2 and the its shared face with cell 1." + +[exchangedata.exchangedata.item.fields.hwva] +block = "exchangedata" +name = "hwva" +type = "double precision" +reader = "urword" +optional = "false" +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." + +[exchangedata.exchangedata.item.fields.aux] +block = "exchangedata" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +optional = "true" +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." +mf6internal = "auxvar" + +[exchangedata.exchangedata.item.fields.boundname] +block = "exchangedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/exg-gwfgwe.toml b/flopy/mf6/data/dfn/toml/exg-gwfgwe.toml new file mode 100644 index 0000000000..187be97685 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/exg-gwfgwe.toml @@ -0,0 +1,3 @@ +name = "exg-gwfgwe" +advanced = false +multi = false diff --git a/flopy/mf6/data/dfn/toml/exg-gwfgwf.toml b/flopy/mf6/data/dfn/toml/exg-gwfgwf.toml new file mode 100644 index 0000000000..7a015e0ac9 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/exg-gwfgwf.toml @@ -0,0 +1,283 @@ +name = "exg-gwfgwf" +advanced = false +multi = true + +[fkeys.gnc_filerecord] +parent = "parent_model_or_package" +key = "gnc_filerecord" +val = "gncdata" +abbr = "gnc" +param = "gncdata" + +[fkeys.mvr_filerecord] +parent = "parent_model_or_package" +key = "mvr_filerecord" +val = "perioddata" +abbr = "mvr" +param = "perioddata" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of gwf exchange cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprpak" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "ipakcb" + +[options.cell_averaging] +block = "options" +name = "cell_averaging" +type = "string" +reader = "urword" +optional = true +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." +valid = "harmonic logarithmic amt-lmk" + +[options.cvoptions] +block = "options" +name = "cvoptions" +type = "record" +reader = "urword" +optional = true +longname = "vertical conductance options" +description = "none" + +[options.cvoptions.fields.variablecv] +block = "options" +name = "variablecv" +type = "keyword" +reader = "urword" +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." + +[options.cvoptions.fields.dewatered] +block = "options" +name = "dewatered" +type = "keyword" +reader = "urword" +optional = "true" +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." + +[options.newton] +block = "options" +name = "newton" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.xt3d] +block = "options" +name = "xt3d" +type = "keyword" +reader = "urword" +optional = true +longname = "keyword to activate xt3d" +description = "keyword that activates the xt3d formulation between the cells connected with this gwf-gwf exchange." + +[options.gncdata] +block = "options" +name = "gncdata" +type = "record gnc6 filein gnc6_filename" +reader = "urword" +optional = true +description = "Contains data for the gnc package. Data can be passed as a dictionary to the gnc package with variable names as keys and package data as values. Data for the gncdata variable is also acceptable. See gnc package documentation for more information." + +[options.gncdata.ref] +parent = "parent_model_or_package" +key = "gnc_filerecord" +val = "gncdata" +abbr = "gnc" +param = "gncdata" + +[options.perioddata] +block = "options" +name = "perioddata" +type = "record mvr6 filein mvr6_filename" +reader = "urword" +optional = true +description = "Contains data for the mvr package. Data can be passed as a dictionary to the mvr package with variable names as keys and package data as values. Data for the perioddata variable is also acceptable. See mvr package documentation for more information." + +[options.perioddata.ref] +parent = "parent_model_or_package" +key = "mvr_filerecord" +val = "perioddata" +abbr = "mvr" +param = "perioddata" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.dev_interfacemodel_on] +block = "options" +name = "dev_interfacemodel_on" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "dev_ifmod_on" + +[dimensions.nexg] +block = "dimensions" +name = "nexg" +type = "integer" +reader = "urword" +optional = false +longname = "number of exchanges" +description = "keyword and integer value specifying the number of gwf-gwf exchanges." + +[exchangedata.exchangedata] +block = "exchangedata" +name = "exchangedata" +type = "list" +shape = "(nexg)" +reader = "urword" +optional = false +longname = "exchange data" + +[exchangedata.exchangedata.item] +name = "exchangedata" +type = "record" +block = "exchangedata" +reader = "urword" +optional = false +longname = "exchange data" + +[exchangedata.exchangedata.item.fields.cellidm1] +block = "exchangedata" +name = "cellidm1" +type = "integer" +reader = "urword" +optional = "false" +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." +numeric_index = "true" + +[exchangedata.exchangedata.item.fields.cellidm2] +block = "exchangedata" +name = "cellidm2" +type = "integer" +reader = "urword" +optional = "false" +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." +numeric_index = "true" + +[exchangedata.exchangedata.item.fields.ihc] +block = "exchangedata" +name = "ihc" +type = "integer" +reader = "urword" +optional = "false" +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." + +[exchangedata.exchangedata.item.fields.cl1] +block = "exchangedata" +name = "cl1" +type = "double precision" +reader = "urword" +optional = "false" +longname = "connection distance" +description = "is the distance between the center of cell 1 and the its shared face with cell 2." + +[exchangedata.exchangedata.item.fields.cl2] +block = "exchangedata" +name = "cl2" +type = "double precision" +reader = "urword" +optional = "false" +longname = "connection distance" +description = "is the distance between the center of cell 2 and the its shared face with cell 1." + +[exchangedata.exchangedata.item.fields.hwva] +block = "exchangedata" +name = "hwva" +type = "double precision" +reader = "urword" +optional = "false" +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." + +[exchangedata.exchangedata.item.fields.aux] +block = "exchangedata" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +optional = "true" +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." +mf6internal = "auxvar" + +[exchangedata.exchangedata.item.fields.boundname] +block = "exchangedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/exg-gwfgwt.toml b/flopy/mf6/data/dfn/toml/exg-gwfgwt.toml new file mode 100644 index 0000000000..54f7fd3ce0 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/exg-gwfgwt.toml @@ -0,0 +1,3 @@ +name = "exg-gwfgwt" +advanced = false +multi = false diff --git a/flopy/mf6/data/dfn/toml/exg-gwfprt.toml b/flopy/mf6/data/dfn/toml/exg-gwfprt.toml new file mode 100644 index 0000000000..4c92dea0a0 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/exg-gwfprt.toml @@ -0,0 +1,3 @@ +name = "exg-gwfprt" +advanced = false +multi = false diff --git a/flopy/mf6/data/dfn/toml/exg-gwtgwt.toml b/flopy/mf6/data/dfn/toml/exg-gwtgwt.toml new file mode 100644 index 0000000000..62b00a018e --- /dev/null +++ b/flopy/mf6/data/dfn/toml/exg-gwtgwt.toml @@ -0,0 +1,253 @@ +name = "exg-gwtgwt" +advanced = false +multi = true + +[fkeys.mvt_filerecord] +parent = "parent_model_or_package" +key = "mvt_filerecord" +val = "perioddata" +abbr = "mvt" +param = "perioddata" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.gwfmodelname1] +block = "options" +name = "gwfmodelname1" +type = "string" +reader = "urword" +optional = false +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." + +[options.gwfmodelname2] +block = "options" +name = "gwfmodelname2" +type = "string" +reader = "urword" +optional = false +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." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of gwt exchange cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprpak" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "ipakcb" + +[options.adv_scheme] +block = "options" +name = "adv_scheme" +type = "string" +reader = "urword" +optional = true +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." +valid = "upstream central tvd" + +[options.dsp_xt3d_off] +block = "options" +name = "dsp_xt3d_off" +type = "keyword" +reader = "urword" +optional = true +longname = "deactivate xt3d" +description = "deactivate the xt3d method for the dispersive flux and use the faster and less accurate approximation for this exchange." + +[options.dsp_xt3d_rhs] +block = "options" +name = "dsp_xt3d_rhs" +type = "keyword" +reader = "urword" +optional = true +longname = "xt3d on right-hand side" +description = "add xt3d dispersion terms to right-hand side, when possible, for this exchange." + +[options.perioddata] +block = "options" +name = "perioddata" +type = "record mvt6 filein mvt6_filename" +reader = "urword" +optional = true +description = "Contains data for the mvt package. Data can be passed as a dictionary to the mvt package with variable names as keys and package data as values. Data for the perioddata variable is also acceptable. See mvt package documentation for more information." + +[options.perioddata.ref] +parent = "parent_model_or_package" +key = "mvt_filerecord" +val = "perioddata" +abbr = "mvt" +param = "perioddata" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.dev_interfacemodel_on] +block = "options" +name = "dev_interfacemodel_on" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "dev_ifmod_on" + +[dimensions.nexg] +block = "dimensions" +name = "nexg" +type = "integer" +reader = "urword" +optional = false +longname = "number of exchanges" +description = "keyword and integer value specifying the number of gwt-gwt exchanges." + +[exchangedata.exchangedata] +block = "exchangedata" +name = "exchangedata" +type = "list" +shape = "(nexg)" +reader = "urword" +optional = false +longname = "exchange data" + +[exchangedata.exchangedata.item] +name = "exchangedata" +type = "record" +block = "exchangedata" +reader = "urword" +optional = false +longname = "exchange data" + +[exchangedata.exchangedata.item.fields.cellidm1] +block = "exchangedata" +name = "cellidm1" +type = "integer" +reader = "urword" +optional = "false" +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." +numeric_index = "true" + +[exchangedata.exchangedata.item.fields.cellidm2] +block = "exchangedata" +name = "cellidm2" +type = "integer" +reader = "urword" +optional = "false" +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." +numeric_index = "true" + +[exchangedata.exchangedata.item.fields.ihc] +block = "exchangedata" +name = "ihc" +type = "integer" +reader = "urword" +optional = "false" +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." + +[exchangedata.exchangedata.item.fields.cl1] +block = "exchangedata" +name = "cl1" +type = "double precision" +reader = "urword" +optional = "false" +longname = "connection distance" +description = "is the distance between the center of cell 1 and the its shared face with cell 2." + +[exchangedata.exchangedata.item.fields.cl2] +block = "exchangedata" +name = "cl2" +type = "double precision" +reader = "urword" +optional = "false" +longname = "connection distance" +description = "is the distance between the center of cell 2 and the its shared face with cell 1." + +[exchangedata.exchangedata.item.fields.hwva] +block = "exchangedata" +name = "hwva" +type = "double precision" +reader = "urword" +optional = "false" +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." + +[exchangedata.exchangedata.item.fields.aux] +block = "exchangedata" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +optional = "true" +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." +mf6internal = "auxvar" + +[exchangedata.exchangedata.item.fields.boundname] +block = "exchangedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwe-adv.toml b/flopy/mf6/data/dfn/toml/gwe-adv.toml new file mode 100644 index 0000000000..fc7b0b3354 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-adv.toml @@ -0,0 +1,22 @@ +name = "gwe-adv" +advanced = false +multi = false + +[options.scheme] +block = "options" +name = "scheme" +type = "string" +reader = "urword" +optional = true +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." +valid = "central upstream tvd" + +[options.ats_percel] +block = "options" +name = "ats_percel" +type = "double precision" +reader = "urword" +optional = true +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." diff --git a/flopy/mf6/data/dfn/toml/gwe-cnd.toml b/flopy/mf6/data/dfn/toml/gwe-cnd.toml new file mode 100644 index 0000000000..d1de007c56 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-cnd.toml @@ -0,0 +1,126 @@ +name = "gwe-cnd" +advanced = false +multi = false + +[options.xt3d_off] +block = "options" +name = "xt3d_off" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.xt3d_rhs] +block = "options" +name = "xt3d_rhs" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[griddata.alh] +block = "griddata" +name = "alh" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.alv] +block = "griddata" +name = "alv" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.ath1] +block = "griddata" +name = "ath1" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.ath2] +block = "griddata" +name = "ath2" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.atv] +block = "griddata" +name = "atv" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.ktw] +block = "griddata" +name = "ktw" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.kts] +block = "griddata" +name = "kts" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +longname = "thermal conductivity of the aquifer material" +description = "thermal conductivity of the solid aquifer material" +layered = true +netcdf = true diff --git a/flopy/mf6/data/dfn/toml/gwe-ctp.toml b/flopy/mf6/data/dfn/toml/gwe-ctp.toml new file mode 100644 index 0000000000..2dd86236fa --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-ctp.toml @@ -0,0 +1,173 @@ +name = "gwe-ctp" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.auxmultname] +block = "options" +name = "auxmultname" +type = "string" +reader = "urword" +optional = true +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of temperature value." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of constant temperature cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "ipakcb" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprpak" + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[dimensions.maxbound] +block = "dimensions" +name = "maxbound" +type = "integer" +reader = "urword" +optional = false +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." + +[period] +transient_block = true + +[period.stress_period_data] +block = "period" +name = "stress_period_data" +type = "list" +shape = "(maxbound)" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item] +name = "stress_period_data" +type = "record" +block = "period" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item.fields.cellid] +block = "period" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[period.stress_period_data.item.fields.temp] +block = "period" +name = "temp" +type = "double precision" +reader = "urword" +time_series = "true" +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." +mf6internal = "tspvar" + +[period.stress_period_data.item.fields.aux] +block = "period" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +optional = "true" +time_series = "true" +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." +mf6internal = "auxvar" + +[period.stress_period_data.item.fields.boundname] +block = "period" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwe-dis.toml b/flopy/mf6/data/dfn/toml/gwe-dis.toml new file mode 100644 index 0000000000..d250486fdd --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-dis.toml @@ -0,0 +1,214 @@ +name = "gwe-dis" +advanced = false +multi = false + +[fkeys.ncf_filerecord] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[options.length_units] +block = "options" +name = "length_units" +type = "string" +reader = "urword" +optional = true +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'." + +[options.nogrb] +block = "options" +name = "nogrb" +type = "keyword" +reader = "urword" +optional = true +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." + +[options.grb_filerecord] +block = "options" +name = "grb_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.grb_filerecord.fields.grb6] +block = "options" +name = "grb6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." +extended = "true" + +[options.grb_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.grb_filerecord.fields.grb6_filename] +block = "options" +name = "grb6_filename" +type = "string" +reader = "urword" +optional = "false" +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'." +extended = "true" + +[options.xorigin] +block = "options" +name = "xorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.yorigin] +block = "options" +name = "yorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.angrot] +block = "options" +name = "angrot" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[options.packagedata] +block = "options" +name = "packagedata" +type = "record ncf6 filein ncf6_filename" +reader = "urword" +optional = true +description = "Contains data for the ncf package. Data can be passed as a dictionary to the ncf package with variable names as keys and package data as values. Data for the packagedata variable is also acceptable. See ncf package documentation for more information." + +[options.packagedata.ref] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[dimensions.nlay] +block = "dimensions" +name = "nlay" +type = "integer" +default = 1 +reader = "urword" +optional = false +longname = "number of layers" +description = "is the number of layers in the model grid." + +[dimensions.nrow] +block = "dimensions" +name = "nrow" +type = "integer" +default = 2 +reader = "urword" +optional = false +longname = "number of rows" +description = "is the number of rows in the model grid." + +[dimensions.ncol] +block = "dimensions" +name = "ncol" +type = "integer" +default = 2 +reader = "urword" +optional = false +longname = "number of columns" +description = "is the number of columns in the model grid." + +[griddata.delr] +block = "griddata" +name = "delr" +type = "double precision" +shape = "(ncol)" +default = 1.0 +reader = "readarray" +longname = "spacing along a row" +description = "is the column spacing in the row direction." +netcdf = true + +[griddata.delc] +block = "griddata" +name = "delc" +type = "double precision" +shape = "(nrow)" +default = 1.0 +reader = "readarray" +longname = "spacing along a column" +description = "is the row spacing in the column direction." +netcdf = true + +[griddata.top] +block = "griddata" +name = "top" +type = "double precision" +shape = "(ncol, nrow)" +default = 1.0 +reader = "readarray" +longname = "cell top elevation" +description = "is the top elevation for each cell in the top model layer." +netcdf = true + +[griddata.botm] +block = "griddata" +name = "botm" +type = "double precision" +shape = "(ncol, nrow, nlay)" +default = 0.0 +reader = "readarray" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." +layered = true +netcdf = true + +[griddata.idomain] +block = "griddata" +name = "idomain" +type = "integer" +shape = "(ncol, nrow, nlay)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true diff --git a/flopy/mf6/data/dfn/toml/gwe-disu.toml b/flopy/mf6/data/dfn/toml/gwe-disu.toml new file mode 100644 index 0000000000..045df2de9d --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-disu.toml @@ -0,0 +1,341 @@ +name = "gwe-disu" +advanced = false +multi = false + +[options.length_units] +block = "options" +name = "length_units" +type = "string" +reader = "urword" +optional = true +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'." + +[options.nogrb] +block = "options" +name = "nogrb" +type = "keyword" +reader = "urword" +optional = true +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." + +[options.grb_filerecord] +block = "options" +name = "grb_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.grb_filerecord.fields.grb6] +block = "options" +name = "grb6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." +extended = "true" + +[options.grb_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.grb_filerecord.fields.grb6_filename] +block = "options" +name = "grb6_filename" +type = "string" +reader = "urword" +optional = "false" +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'." +extended = "true" + +[options.xorigin] +block = "options" +name = "xorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.yorigin] +block = "options" +name = "yorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.angrot] +block = "options" +name = "angrot" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.vertical_offset_tolerance] +block = "options" +name = "vertical_offset_tolerance" +type = "double precision" +default = 0.0 +reader = "urword" +optional = true +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." +mf6internal = "voffsettol" + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[dimensions.nodes] +block = "dimensions" +name = "nodes" +type = "integer" +reader = "urword" +optional = false +longname = "number of layers" +description = "is the number of cells in the model grid." + +[dimensions.nja] +block = "dimensions" +name = "nja" +type = "integer" +reader = "urword" +optional = false +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." + +[dimensions.nvert] +block = "dimensions" +name = "nvert" +type = "integer" +reader = "urword" +optional = true +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." + +[griddata.top] +block = "griddata" +name = "top" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +longname = "cell top elevation" +description = "is the top elevation for each cell in the model grid." + +[griddata.bot] +block = "griddata" +name = "bot" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." + +[griddata.area] +block = "griddata" +name = "area" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +longname = "cell surface area" +description = "is the cell surface area (in plan view)." + +[griddata.idomain] +block = "griddata" +name = "idomain" +type = "integer" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = false + +[connectiondata.iac] +block = "connectiondata" +name = "iac" +type = "integer" +shape = "(nodes)" +reader = "readarray" +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." + +[connectiondata.ja] +block = "connectiondata" +name = "ja" +type = "integer" +shape = "(nja)" +reader = "readarray" +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." +numeric_index = true +jagged_array = "iac" + +[connectiondata.ihc] +block = "connectiondata" +name = "ihc" +type = "integer" +shape = "(nja)" +reader = "readarray" +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." +jagged_array = "iac" + +[connectiondata.cl12] +block = "connectiondata" +name = "cl12" +type = "double precision" +shape = "(nja)" +reader = "readarray" +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." +jagged_array = "iac" + +[connectiondata.hwva] +block = "connectiondata" +name = "hwva" +type = "double precision" +shape = "(nja)" +reader = "readarray" +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." +jagged_array = "iac" + +[connectiondata.angldegx] +block = "connectiondata" +name = "angldegx" +type = "double precision" +shape = "(nja)" +reader = "readarray" +optional = true +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." +jagged_array = "iac" + +[vertices.vertices] +block = "vertices" +name = "vertices" +type = "list" +shape = "(nvert)" +reader = "urword" +optional = false +longname = "vertices data" + +[vertices.vertices.item] +name = "vertices" +type = "record" +block = "vertices" +reader = "urword" +optional = false +longname = "vertices data" + +[vertices.vertices.item.fields.iv] +block = "vertices" +name = "iv" +type = "integer" +reader = "urword" +optional = "false" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +numeric_index = "true" + +[vertices.vertices.item.fields.xv] +block = "vertices" +name = "xv" +type = "double precision" +reader = "urword" +optional = "false" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." + +[vertices.vertices.item.fields.yv] +block = "vertices" +name = "yv" +type = "double precision" +reader = "urword" +optional = "false" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." + +[cell2d.cell2d] +block = "cell2d" +name = "cell2d" +type = "list" +shape = "(nodes)" +reader = "urword" +optional = false +longname = "cell2d data" + +[cell2d.cell2d.item] +name = "cell2d" +type = "record" +block = "cell2d" +reader = "urword" +optional = false +longname = "cell2d data" + +[cell2d.cell2d.item.fields.icell2d] +block = "cell2d" +name = "icell2d" +type = "integer" +reader = "urword" +optional = "false" +longname = "cell2d number" +description = "is the cell2d number. Records in the CELL2D block must be listed in consecutive order from 1 to NODES." +numeric_index = "true" + +[cell2d.cell2d.item.fields.xc] +block = "cell2d" +name = "xc" +type = "double precision" +reader = "urword" +optional = "false" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." + +[cell2d.cell2d.item.fields.yc] +block = "cell2d" +name = "yc" +type = "double precision" +reader = "urword" +optional = "false" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." + +[cell2d.cell2d.item.fields.ncvert] +block = "cell2d" +name = "ncvert" +type = "integer" +reader = "urword" +optional = "false" +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." + +[cell2d.cell2d.item.fields.icvert] +block = "cell2d" +name = "icvert" +type = "integer" +shape = "(ncvert)" +reader = "urword" +optional = "false" +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." +numeric_index = "true" diff --git a/flopy/mf6/data/dfn/toml/gwe-disv.toml b/flopy/mf6/data/dfn/toml/gwe-disv.toml new file mode 100644 index 0000000000..849a9dc1ad --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-disv.toml @@ -0,0 +1,297 @@ +name = "gwe-disv" +advanced = false +multi = false + +[fkeys.ncf_filerecord] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[options.length_units] +block = "options" +name = "length_units" +type = "string" +reader = "urword" +optional = true +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'." + +[options.nogrb] +block = "options" +name = "nogrb" +type = "keyword" +reader = "urword" +optional = true +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." + +[options.grb_filerecord] +block = "options" +name = "grb_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.grb_filerecord.fields.grb6] +block = "options" +name = "grb6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." +extended = "true" + +[options.grb_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.grb_filerecord.fields.grb6_filename] +block = "options" +name = "grb6_filename" +type = "string" +reader = "urword" +optional = "false" +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'." +extended = "true" + +[options.xorigin] +block = "options" +name = "xorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.yorigin] +block = "options" +name = "yorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.angrot] +block = "options" +name = "angrot" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[options.packagedata] +block = "options" +name = "packagedata" +type = "record ncf6 filein ncf6_filename" +reader = "urword" +optional = true +description = "Contains data for the ncf package. Data can be passed as a dictionary to the ncf package with variable names as keys and package data as values. Data for the packagedata variable is also acceptable. See ncf package documentation for more information." + +[options.packagedata.ref] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[dimensions.nlay] +block = "dimensions" +name = "nlay" +type = "integer" +reader = "urword" +optional = false +longname = "number of layers" +description = "is the number of layers in the model grid." + +[dimensions.ncpl] +block = "dimensions" +name = "ncpl" +type = "integer" +reader = "urword" +optional = false +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." + +[dimensions.nvert] +block = "dimensions" +name = "nvert" +type = "integer" +reader = "urword" +optional = false +longname = "number of columns" +description = "is the total number of (x, y) vertex pairs used to characterize the horizontal configuration of the model grid." + +[griddata.top] +block = "griddata" +name = "top" +type = "double precision" +shape = "(ncpl)" +reader = "readarray" +longname = "model top elevation" +description = "is the top elevation for each cell in the top model layer." +netcdf = true + +[griddata.botm] +block = "griddata" +name = "botm" +type = "double precision" +shape = "(ncpl, nlay)" +reader = "readarray" +longname = "model bottom elevation" +description = "is the bottom elevation for each cell." +layered = true +netcdf = true + +[griddata.idomain] +block = "griddata" +name = "idomain" +type = "integer" +shape = "(ncpl, nlay)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[vertices.vertices] +block = "vertices" +name = "vertices" +type = "list" +shape = "(nvert)" +reader = "urword" +optional = false +longname = "vertices data" + +[vertices.vertices.item] +name = "vertices" +type = "record" +block = "vertices" +reader = "urword" +optional = false +longname = "vertices data" + +[vertices.vertices.item.fields.iv] +block = "vertices" +name = "iv" +type = "integer" +reader = "urword" +optional = "false" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +numeric_index = "true" + +[vertices.vertices.item.fields.xv] +block = "vertices" +name = "xv" +type = "double precision" +reader = "urword" +optional = "false" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." + +[vertices.vertices.item.fields.yv] +block = "vertices" +name = "yv" +type = "double precision" +reader = "urword" +optional = "false" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." + +[cell2d.cell2d] +block = "cell2d" +name = "cell2d" +type = "list" +shape = "(ncpl)" +reader = "urword" +optional = false +longname = "cell2d data" + +[cell2d.cell2d.item] +name = "cell2d" +type = "record" +block = "cell2d" +reader = "urword" +optional = false +longname = "cell2d data" + +[cell2d.cell2d.item.fields.icell2d] +block = "cell2d" +name = "icell2d" +type = "integer" +reader = "urword" +optional = "false" +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." +numeric_index = "true" + +[cell2d.cell2d.item.fields.xc] +block = "cell2d" +name = "xc" +type = "double precision" +reader = "urword" +optional = "false" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." + +[cell2d.cell2d.item.fields.yc] +block = "cell2d" +name = "yc" +type = "double precision" +reader = "urword" +optional = "false" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." + +[cell2d.cell2d.item.fields.ncvert] +block = "cell2d" +name = "ncvert" +type = "integer" +reader = "urword" +optional = "false" +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." + +[cell2d.cell2d.item.fields.icvert] +block = "cell2d" +name = "icvert" +type = "integer" +shape = "(ncvert)" +reader = "urword" +optional = "false" +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." +numeric_index = "true" diff --git a/flopy/mf6/data/dfn/toml/gwe-esl.toml b/flopy/mf6/data/dfn/toml/gwe-esl.toml new file mode 100644 index 0000000000..8e2d4e9b23 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-esl.toml @@ -0,0 +1,166 @@ +name = "gwe-esl" +advanced = false +multi = false + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.auxmultname] +block = "options" +name = "auxmultname" +type = "string" +reader = "urword" +optional = true +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of energy loading rate." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of energy source loading cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +longname = "save well 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." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[dimensions.maxbound] +block = "dimensions" +name = "maxbound" +type = "integer" +reader = "urword" +optional = false +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." + +[period] +transient_block = true + +[period.stress_period_data] +block = "period" +name = "stress_period_data" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[period.stress_period_data.item] +name = "stress_period_data" +type = "record" +block = "period" +reader = "urword" + +[period.stress_period_data.item.fields.cellid] +block = "period" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[period.stress_period_data.item.fields.senerrate] +block = "period" +name = "senerrate" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.aux] +block = "period" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +optional = "true" +time_series = "true" +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." + +[period.stress_period_data.item.fields.boundname] +block = "period" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +longname = "well 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." diff --git a/flopy/mf6/data/dfn/toml/gwe-est.toml b/flopy/mf6/data/dfn/toml/gwe-est.toml new file mode 100644 index 0000000000..c5c58f65db --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-est.toml @@ -0,0 +1,117 @@ +name = "gwe-est" +advanced = false +multi = false + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.zero_order_decay_water] +block = "options" +name = "zero_order_decay_water" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.zero_order_decay_solid] +block = "options" +name = "zero_order_decay_solid" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.density_water] +block = "options" +name = "density_water" +type = "double precision" +default = 1000.0 +reader = "urword" +optional = true +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." +mf6internal = "rhow" + +[options.heat_capacity_water] +block = "options" +name = "heat_capacity_water" +type = "double precision" +default = 4184.0 +reader = "urword" +optional = true +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." +mf6internal = "cpw" + +[options.latent_heat_vaporization] +block = "options" +name = "latent_heat_vaporization" +type = "double precision" +default = 2453500.0 +reader = "urword" +optional = true +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." +mf6internal = "latheatvap" + +[griddata.porosity] +block = "griddata" +name = "porosity" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +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." +layered = true + +[griddata.decay_water] +block = "griddata" +name = "decay_water" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true + +[griddata.decay_solid] +block = "griddata" +name = "decay_solid" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true + +[griddata.heat_capacity_solid] +block = "griddata" +name = "heat_capacity_solid" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +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)." +layered = true +mf6internal = "cps" + +[griddata.density_solid] +block = "griddata" +name = "density_solid" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +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." +layered = true +mf6internal = "rhos" diff --git a/flopy/mf6/data/dfn/toml/gwe-fmi.toml b/flopy/mf6/data/dfn/toml/gwe-fmi.toml new file mode 100644 index 0000000000..8a2aeea1f0 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-fmi.toml @@ -0,0 +1,62 @@ +name = "gwe-fmi" +advanced = false +multi = false + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.flow_imbalance_correction] +block = "options" +name = "flow_imbalance_correction" +type = "keyword" +reader = "urword" +optional = true +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." + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +reader = "urword" +optional = false +longname = "flowtype list" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" +optional = false +longname = "flowtype list" + +[packagedata.packagedata.item.fields.flowtype] +block = "packagedata" +name = "flowtype" +type = "string" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.filein] +block = "packagedata" +name = "filein" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an input filename is expected next." + +[packagedata.packagedata.item.fields.fname] +block = "packagedata" +name = "fname" +type = "string" +reader = "urword" +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." diff --git a/flopy/mf6/data/dfn/toml/gwe-ic.toml b/flopy/mf6/data/dfn/toml/gwe-ic.toml new file mode 100644 index 0000000000..535b417934 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-ic.toml @@ -0,0 +1,36 @@ +name = "gwe-ic" +advanced = false +multi = false + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[griddata.strt] +block = "griddata" +name = "strt" +type = "double precision" +shape = "(nodes)" +default = 0.0 +reader = "readarray" +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." +layered = true +netcdf = true diff --git a/flopy/mf6/data/dfn/toml/gwe-lke.toml b/flopy/mf6/data/dfn/toml/gwe-lke.toml new file mode 100644 index 0000000000..392d14e7e2 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-lke.toml @@ -0,0 +1,402 @@ +name = "gwe-lke" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.flow_package_name] +block = "options" +name = "flow_package_name" +type = "string" +reader = "urword" +optional = true +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)." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.flow_package_auxiliary_name] +block = "options" +name = "flow_package_auxiliary_name" +type = "string" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of lake cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_temperature] +block = "options" +name = "print_temperature" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.temperature_filerecord] +block = "options" +name = "temperature_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.temperature_filerecord.fields.temperature] +block = "period" +name = "temperature" +type = "string" +time_series = "true" +reader = "urword" +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." + +[options.temperature_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.temperature_filerecord.fields.tempfile] +block = "options" +name = "tempfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write temperature information." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.lakeno] +block = "period" +name = "lakeno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.strt] +block = "packagedata" +name = "strt" +type = "double precision" +reader = "urword" +longname = "starting lake temperature" +description = "real value that defines the starting temperature for the lake." + +[packagedata.packagedata.item.fields.ktf] +block = "packagedata" +name = "ktf" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.rbthcnd] +block = "packagedata" +name = "rbthcnd" +type = "double precision" +reader = "urword" +longname = "streambed thickness" +description = "real value that defines the thickness of the lakebed material through which conduction occurs. Must be greater than 0." + +[packagedata.packagedata.item.fields.aux] +block = "packagedata" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +time_series = "true" +optional = "true" +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." + +[packagedata.packagedata.item.fields.boundname] +block = "packagedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." + +[period] +transient_block = true + +[period.lakeperioddata] +block = "period" +name = "lakeperioddata" +type = "list" +reader = "urword" + +[period.lakeperioddata.item] +name = "lakeperioddata" +type = "record" +block = "period" +reader = "urword" + +[period.lakeperioddata.item.fields.lakeno] +block = "period" +name = "lakeno" +type = "integer" +reader = "urword" +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." +numeric_index = true + +[period.lakeperioddata.item.fields.laksetting] +block = "period" +name = "laksetting" +type = "union" +reader = "urword" +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." + +[period.lakeperioddata.item.fields.laksetting.choices.temperature] +block = "period" +name = "temperature" +type = "string" +reader = "urword" +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 + +[period.lakeperioddata.item.fields.laksetting.choices.status] +block = "period" +name = "status" +type = "string" +reader = "urword" +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." + +[period.lakeperioddata.item.fields.laksetting.choices.rainfall] +block = "period" +name = "rainfall" +type = "string" +reader = "urword" +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 + +[period.lakeperioddata.item.fields.laksetting.choices.evaporation] +block = "period" +name = "evaporation" +type = "string" +reader = "urword" +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 + +[period.lakeperioddata.item.fields.laksetting.choices.runoff] +block = "period" +name = "runoff" +type = "string" +reader = "urword" +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 + +[period.lakeperioddata.item.fields.laksetting.choices.ext-inflow] +block = "period" +name = "ext-inflow" +type = "string" +reader = "urword" +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 + +[period.lakeperioddata.item.fields.laksetting.choices.auxiliaryrecord] +block = "period" +name = "auxiliaryrecord" +type = "record" +reader = "urword" + +[period.lakeperioddata.item.fields.laksetting.choices.auxiliaryrecord.fields.auxiliary] +block = "period" +name = "auxiliary" +type = "keyword" +reader = "urword" +description = "keyword for specifying auxiliary variable." + +[period.lakeperioddata.item.fields.laksetting.choices.auxiliaryrecord.fields.auxname] +block = "period" +name = "auxname" +type = "string" +reader = "urword" +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." + +[period.lakeperioddata.item.fields.laksetting.choices.auxiliaryrecord.fields.auxval] +block = "period" +name = "auxval" +type = "double precision" +reader = "urword" +time_series = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwe-mve.toml b/flopy/mf6/data/dfn/toml/gwe-mve.toml new file mode 100644 index 0000000000..e0f475bec8 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-mve.toml @@ -0,0 +1,105 @@ +name = "gwe-mve" +advanced = false +multi = false + +[ref] +parent = "parent_model_or_package" +key = "mve_filerecord" +val = "perioddata" +abbr = "mve" +param = "perioddata" + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." diff --git a/flopy/mf6/data/dfn/toml/gwe-mwe.toml b/flopy/mf6/data/dfn/toml/gwe-mwe.toml new file mode 100644 index 0000000000..300c091bf4 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-mwe.toml @@ -0,0 +1,375 @@ +name = "gwe-mwe" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.flow_package_name] +block = "options" +name = "flow_package_name" +type = "string" +reader = "urword" +optional = true +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)." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.flow_package_auxiliary_name] +block = "options" +name = "flow_package_auxiliary_name" +type = "string" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of well cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_temperature] +block = "options" +name = "print_temperature" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.temperature_filerecord] +block = "options" +name = "temperature_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.temperature_filerecord.fields.temperature] +block = "period" +name = "temperature" +type = "string" +time_series = "true" +reader = "urword" +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." + +[options.temperature_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.temperature_filerecord.fields.tempfile] +block = "options" +name = "tempfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write temperature information." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.mawno] +block = "period" +name = "mawno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.strt] +block = "packagedata" +name = "strt" +type = "double precision" +reader = "urword" +longname = "starting well temperature" +description = "real value that defines the starting temperature for the well." + +[packagedata.packagedata.item.fields.ktf] +block = "packagedata" +name = "ktf" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.fthk] +block = "packagedata" +name = "fthk" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.aux] +block = "packagedata" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +time_series = "true" +optional = "true" +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." + +[packagedata.packagedata.item.fields.boundname] +block = "packagedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." + +[period] +transient_block = true + +[period.mweperioddata] +block = "period" +name = "mweperioddata" +type = "list" +reader = "urword" + +[period.mweperioddata.item] +name = "mweperioddata" +type = "record" +block = "period" +reader = "urword" + +[period.mweperioddata.item.fields.mawno] +block = "period" +name = "mawno" +type = "integer" +reader = "urword" +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." +numeric_index = true + +[period.mweperioddata.item.fields.mwesetting] +block = "period" +name = "mwesetting" +type = "union" +reader = "urword" +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." + +[period.mweperioddata.item.fields.mwesetting.choices.temperature] +block = "period" +name = "temperature" +type = "string" +reader = "urword" +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 + +[period.mweperioddata.item.fields.mwesetting.choices.status] +block = "period" +name = "status" +type = "string" +reader = "urword" +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." + +[period.mweperioddata.item.fields.mwesetting.choices.rate] +block = "period" +name = "rate" +type = "string" +reader = "urword" +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 + +[period.mweperioddata.item.fields.mwesetting.choices.auxiliaryrecord] +block = "period" +name = "auxiliaryrecord" +type = "record" +reader = "urword" + +[period.mweperioddata.item.fields.mwesetting.choices.auxiliaryrecord.fields.auxiliary] +block = "period" +name = "auxiliary" +type = "keyword" +reader = "urword" +description = "keyword for specifying auxiliary variable." + +[period.mweperioddata.item.fields.mwesetting.choices.auxiliaryrecord.fields.auxname] +block = "period" +name = "auxname" +type = "string" +reader = "urword" +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." + +[period.mweperioddata.item.fields.mwesetting.choices.auxiliaryrecord.fields.auxval] +block = "period" +name = "auxval" +type = "double precision" +reader = "urword" +time_series = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwe-nam.toml b/flopy/mf6/data/dfn/toml/gwe-nam.toml new file mode 100644 index 0000000000..e46a4abfb9 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-nam.toml @@ -0,0 +1,195 @@ +name = "gwe-nam" +advanced = false +multi = false + +[options.list] +block = "options" +name = "list" +type = "string" +reader = "urword" +optional = true +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'." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.nc_mesh2d_filerecord] +block = "options" +name = "nc_mesh2d_filerecord" +type = "record" +reader = "urword" +optional = true +description = "netcdf layered mesh fileout record." +mf6internal = "ncmesh2drec" + +[options.nc_mesh2d_filerecord.fields.netcdf_mesh2d] +block = "options" +name = "netcdf_mesh2d" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to a layered mesh netcdf file." +extended = "true" + +[options.nc_mesh2d_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.nc_mesh2d_filerecord.fields.ncmesh2dfile] +block = "options" +name = "ncmesh2dfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the netcdf ugrid layered mesh output file." +extended = "true" + +[options.nc_structured_filerecord] +block = "options" +name = "nc_structured_filerecord" +type = "record" +reader = "urword" +optional = true +description = "netcdf structured fileout record." +mf6internal = "ncstructrec" + +[options.nc_structured_filerecord.fields.netcdf_structured] +block = "options" +name = "netcdf_structured" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to a structured netcdf file." +mf6internal = "netcdf_struct" +extended = "true" + +[options.nc_structured_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.nc_structured_filerecord.fields.ncstructfile] +block = "options" +name = "ncstructfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the netcdf structured output file." +extended = "true" + +[options.nc_filerecord] +block = "options" +name = "nc_filerecord" +type = "record" +reader = "urword" +optional = true +description = "netcdf filerecord" + +[options.nc_filerecord.fields.netcdf] +block = "options" +name = "netcdf" +type = "keyword" +reader = "urword" +optional = "false" +longname = "netcdf keyword" +description = "keyword to specify that record corresponds to a netcdf input file." +extended = "true" + +[options.nc_filerecord.fields.filein] +block = "options" +name = "filein" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an input filename is expected next." + +[options.nc_filerecord.fields.netcdf_filename] +block = "options" +name = "netcdf_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "netcdf input filename" +description = "defines a netcdf input file." +mf6internal = "netcdf_fname" +extended = "true" + +[packages.packages] +block = "packages" +name = "packages" +type = "list" +reader = "urword" +optional = false +longname = "package list" + +[packages.packages.item] +name = "packages" +type = "record" +block = "packages" +reader = "urword" +optional = false +longname = "package list" + +[packages.packages.item.fields.ftype] +block = "packages" +name = "ftype" +type = "string" +reader = "urword" +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." + +[packages.packages.item.fields.fname] +block = "packages" +name = "fname" +type = "string" +reader = "urword" +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." + +[packages.packages.item.fields.pname] +block = "packages" +name = "pname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwe-oc.toml b/flopy/mf6/data/dfn/toml/gwe-oc.toml new file mode 100644 index 0000000000..679f1fd9a3 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-oc.toml @@ -0,0 +1,197 @@ +name = "gwe-oc" +advanced = false +multi = false + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.temperature_filerecord] +block = "options" +name = "temperature_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.temperature_filerecord.fields.temperature] +block = "options" +name = "temperature" +type = "keyword" +reader = "urword" +optional = "false" +longname = "temperature keyword" +description = "keyword to specify that record corresponds to temperature." + +[options.temperature_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.temperature_filerecord.fields.temperaturefile] +block = "options" +name = "temperaturefile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the output file to write temperature information." + +[options.temperatureprintrecord] +block = "options" +name = "temperatureprintrecord" +type = "record" +reader = "urword" +optional = true + +[options.temperatureprintrecord.fields.temperature] +block = "options" +name = "temperature" +type = "keyword" +reader = "urword" +optional = "false" +longname = "temperature keyword" +description = "keyword to specify that record corresponds to temperature." + +[options.temperatureprintrecord.fields.print_format] +block = "options" +name = "print_format" +type = "keyword" +reader = "urword" +optional = "false" +longname = "keyword to indicate that a print format follows" +description = "keyword to specify format for printing to the listing file." + +[period] +transient_block = true + +[period.saverecord] +block = "period" +name = "saverecord" +type = "record" +reader = "urword" +optional = true + +[period.saverecord.fields.save] +block = "period" +name = "save" +type = "keyword" +reader = "urword" +optional = "false" +longname = "keyword to save" +description = "keyword to indicate that information will be saved this stress period." + +[period.saverecord.fields.rtype] +block = "period" +name = "rtype" +type = "string" +reader = "urword" +optional = "false" +longname = "record type" +description = "type of information to save or print. Can be BUDGET or TEMPERATURE." + +[period.saverecord.fields.ocsetting] +block = "period" +name = "ocsetting" +type = "keystring all first last frequency steps" +reader = "urword" +description = "specifies the steps for which the data will be saved." + +[period.printrecord] +block = "period" +name = "printrecord" +type = "record" +reader = "urword" +optional = true + +[period.printrecord.fields.print] +block = "period" +name = "print" +type = "keyword" +reader = "urword" +optional = "false" +longname = "keyword to save" +description = "keyword to indicate that information will be printed this stress period." + +[period.printrecord.fields.rtype] +block = "period" +name = "rtype" +type = "string" +reader = "urword" +optional = "false" +longname = "record type" +description = "type of information to save or print. Can be BUDGET or TEMPERATURE." + +[period.printrecord.fields.ocsetting] +block = "period" +name = "ocsetting" +type = "keystring all first last frequency steps" +reader = "urword" +description = "specifies the steps for which the data will be saved." diff --git a/flopy/mf6/data/dfn/toml/gwe-sfe.toml b/flopy/mf6/data/dfn/toml/gwe-sfe.toml new file mode 100644 index 0000000000..af484339ab --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-sfe.toml @@ -0,0 +1,402 @@ +name = "gwe-sfe" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.flow_package_name] +block = "options" +name = "flow_package_name" +type = "string" +reader = "urword" +optional = true +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)." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.flow_package_auxiliary_name] +block = "options" +name = "flow_package_auxiliary_name" +type = "string" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of reach cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_temperature] +block = "options" +name = "print_temperature" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.temperature_filerecord] +block = "options" +name = "temperature_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.temperature_filerecord.fields.temperature] +block = "period" +name = "temperature" +type = "string" +time_series = "true" +reader = "urword" +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." + +[options.temperature_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.temperature_filerecord.fields.tempfile] +block = "options" +name = "tempfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write temperature information." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.rno] +block = "period" +name = "rno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.strt] +block = "packagedata" +name = "strt" +type = "double precision" +reader = "urword" +longname = "starting reach temperature" +description = "real value that defines the starting temperature for the reach." + +[packagedata.packagedata.item.fields.ktf] +block = "packagedata" +name = "ktf" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.rbthcnd] +block = "packagedata" +name = "rbthcnd" +type = "double precision" +reader = "urword" +longname = "streambed thickness" +description = "real value that defines the thickness of the streambed material through which conduction occurs. Must be greater than 0." + +[packagedata.packagedata.item.fields.aux] +block = "packagedata" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +time_series = "true" +optional = "true" +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." + +[packagedata.packagedata.item.fields.boundname] +block = "packagedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." + +[period] +transient_block = true + +[period.reachperioddata] +block = "period" +name = "reachperioddata" +type = "list" +reader = "urword" + +[period.reachperioddata.item] +name = "reachperioddata" +type = "record" +block = "period" +reader = "urword" + +[period.reachperioddata.item.fields.rno] +block = "period" +name = "rno" +type = "integer" +reader = "urword" +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." +numeric_index = true + +[period.reachperioddata.item.fields.reachsetting] +block = "period" +name = "reachsetting" +type = "union" +reader = "urword" +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." + +[period.reachperioddata.item.fields.reachsetting.choices.temperature] +block = "period" +name = "temperature" +type = "string" +reader = "urword" +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 + +[period.reachperioddata.item.fields.reachsetting.choices.status] +block = "period" +name = "status" +type = "string" +reader = "urword" +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." + +[period.reachperioddata.item.fields.reachsetting.choices.rainfall] +block = "period" +name = "rainfall" +type = "string" +reader = "urword" +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 + +[period.reachperioddata.item.fields.reachsetting.choices.evaporation] +block = "period" +name = "evaporation" +type = "string" +reader = "urword" +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 + +[period.reachperioddata.item.fields.reachsetting.choices.runoff] +block = "period" +name = "runoff" +type = "string" +reader = "urword" +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 + +[period.reachperioddata.item.fields.reachsetting.choices.inflow] +block = "period" +name = "inflow" +type = "string" +reader = "urword" +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 + +[period.reachperioddata.item.fields.reachsetting.choices.auxiliaryrecord] +block = "period" +name = "auxiliaryrecord" +type = "record" +reader = "urword" + +[period.reachperioddata.item.fields.reachsetting.choices.auxiliaryrecord.fields.auxiliary] +block = "period" +name = "auxiliary" +type = "keyword" +reader = "urword" +description = "keyword for specifying auxiliary variable." + +[period.reachperioddata.item.fields.reachsetting.choices.auxiliaryrecord.fields.auxname] +block = "period" +name = "auxname" +type = "string" +reader = "urword" +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." + +[period.reachperioddata.item.fields.reachsetting.choices.auxiliaryrecord.fields.auxval] +block = "period" +name = "auxval" +type = "double precision" +reader = "urword" +time_series = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwe-ssm.toml b/flopy/mf6/data/dfn/toml/gwe-ssm.toml new file mode 100644 index 0000000000..f7d723c8a4 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-ssm.toml @@ -0,0 +1,119 @@ +name = "gwe-ssm" +advanced = false +multi = false + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[sources.sources] +block = "sources" +name = "sources" +type = "list" +reader = "urword" +optional = false +longname = "package list" + +[sources.sources.item] +name = "sources" +type = "record" +block = "sources" +reader = "urword" +optional = false +longname = "package list" + +[sources.sources.item.fields.pname] +block = "fileinput" +name = "pname" +type = "string" +reader = "urword" +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." + +[sources.sources.item.fields.srctype] +block = "sources" +name = "srctype" +type = "string" +optional = "false" +reader = "urword" +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." + +[sources.sources.item.fields.auxname] +block = "sources" +name = "auxname" +type = "string" +reader = "urword" +optional = "false" +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." + +[fileinput.fileinput] +block = "fileinput" +name = "fileinput" +type = "list" +reader = "urword" + +[fileinput.fileinput.item] +name = "fileinput" +type = "record" +block = "fileinput" +reader = "urword" + +[fileinput.fileinput.item.fields.pname] +block = "fileinput" +name = "pname" +type = "string" +reader = "urword" +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." + +[fileinput.fileinput.item.fields.spc6] +block = "fileinput" +name = "spc6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "head keyword" +description = "keyword to specify that record corresponds to a source sink mixing input file." + +[fileinput.fileinput.item.fields.filein] +block = "fileinput" +name = "filein" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an input filename is expected next." + +[fileinput.fileinput.item.fields.spc6_filename] +block = "fileinput" +name = "spc6_filename" +type = "string" +reader = "urword" +optional = "false" +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." + +[fileinput.fileinput.item.fields.mixed] +block = "fileinput" +name = "mixed" +type = "keyword" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwe-uze.toml b/flopy/mf6/data/dfn/toml/gwe-uze.toml new file mode 100644 index 0000000000..e6bfa5eb7d --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwe-uze.toml @@ -0,0 +1,368 @@ +name = "gwe-uze" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.flow_package_name] +block = "options" +name = "flow_package_name" +type = "string" +reader = "urword" +optional = true +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)." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.flow_package_auxiliary_name] +block = "options" +name = "flow_package_auxiliary_name" +type = "string" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of unsaturated zone flow cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_temperature] +block = "options" +name = "print_temperature" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.temperature_filerecord] +block = "options" +name = "temperature_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.temperature_filerecord.fields.temperature] +block = "period" +name = "temperature" +type = "string" +time_series = "true" +reader = "urword" +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." + +[options.temperature_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.temperature_filerecord.fields.tempfile] +block = "options" +name = "tempfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write temperature information." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.uzfno] +block = "period" +name = "uzfno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.strt] +block = "packagedata" +name = "strt" +type = "double precision" +reader = "urword" +longname = "starting UZF cell temperature" +description = "real value that defines the starting temperature for the unsaturated zone flow cell." + +[packagedata.packagedata.item.fields.aux] +block = "packagedata" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +time_series = "true" +optional = "true" +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." + +[packagedata.packagedata.item.fields.boundname] +block = "packagedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." + +[period] +transient_block = true + +[period.uzeperioddata] +block = "period" +name = "uzeperioddata" +type = "list" +reader = "urword" + +[period.uzeperioddata.item] +name = "uzeperioddata" +type = "record" +block = "period" +reader = "urword" + +[period.uzeperioddata.item.fields.uzfno] +block = "period" +name = "uzfno" +type = "integer" +reader = "urword" +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." +numeric_index = true + +[period.uzeperioddata.item.fields.uzesetting] +block = "period" +name = "uzesetting" +type = "union" +reader = "urword" +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." + +[period.uzeperioddata.item.fields.uzesetting.choices.temperature] +block = "period" +name = "temperature" +type = "string" +reader = "urword" +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 + +[period.uzeperioddata.item.fields.uzesetting.choices.status] +block = "period" +name = "status" +type = "string" +reader = "urword" +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." + +[period.uzeperioddata.item.fields.uzesetting.choices.infiltration] +block = "period" +name = "infiltration" +type = "string" +reader = "urword" +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 + +[period.uzeperioddata.item.fields.uzesetting.choices.uzet] +block = "period" +name = "uzet" +type = "string" +reader = "urword" +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 + +[period.uzeperioddata.item.fields.uzesetting.choices.auxiliaryrecord] +block = "period" +name = "auxiliaryrecord" +type = "record" +reader = "urword" + +[period.uzeperioddata.item.fields.uzesetting.choices.auxiliaryrecord.fields.auxiliary] +block = "period" +name = "auxiliary" +type = "keyword" +reader = "urword" +description = "keyword for specifying auxiliary variable." + +[period.uzeperioddata.item.fields.uzesetting.choices.auxiliaryrecord.fields.auxname] +block = "period" +name = "auxname" +type = "string" +reader = "urword" +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." + +[period.uzeperioddata.item.fields.uzesetting.choices.auxiliaryrecord.fields.auxval] +block = "period" +name = "auxval" +type = "double precision" +reader = "urword" +time_series = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-api.toml b/flopy/mf6/data/dfn/toml/gwf-api.toml new file mode 100644 index 0000000000..b252b4ff39 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-api.toml @@ -0,0 +1,77 @@ +name = "gwf-api" +advanced = false +multi = false + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of api boundary cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.mover] +block = "options" +name = "mover" +type = "keyword" +reader = "urword" +optional = true +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." + +[dimensions.maxbound] +block = "dimensions" +name = "maxbound" +type = "integer" +reader = "urword" +optional = false +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-buy.toml b/flopy/mf6/data/dfn/toml/gwf-buy.toml new file mode 100644 index 0000000000..71123b3ed0 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-buy.toml @@ -0,0 +1,128 @@ +name = "gwf-buy" +advanced = false +multi = false + +[options.hhformulation_rhs] +block = "options" +name = "hhformulation_rhs" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.denseref] +block = "options" +name = "denseref" +type = "double precision" +default = 1000.0 +reader = "urword" +optional = true +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." + +[options.density_filerecord] +block = "options" +name = "density_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.density_filerecord.fields.density] +block = "options" +name = "density" +type = "keyword" +reader = "urword" +optional = "false" +longname = "density keyword" +description = "keyword to specify that record corresponds to density." + +[options.density_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.density_filerecord.fields.densityfile] +block = "options" +name = "densityfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.dev_efh_formulation] +block = "options" +name = "dev_efh_formulation" +type = "keyword" +reader = "urword" +optional = true +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." + +[dimensions.nrhospecies] +block = "dimensions" +name = "nrhospecies" +type = "integer" +reader = "urword" +optional = false +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." + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(nrhospecies)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.irhospec] +block = "packagedata" +name = "irhospec" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.drhodc] +block = "packagedata" +name = "drhodc" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.crhoref] +block = "packagedata" +name = "crhoref" +type = "double precision" +reader = "urword" +longname = "reference concentration value" +description = "real value that defines the reference concentration value used for this species in the density equation of state." + +[packagedata.packagedata.item.fields.modelname] +block = "packagedata" +name = "modelname" +type = "string" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.auxspeciesname] +block = "packagedata" +name = "auxspeciesname" +type = "string" +reader = "urword" +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-chd.toml b/flopy/mf6/data/dfn/toml/gwf-chd.toml new file mode 100644 index 0000000000..a0af773830 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-chd.toml @@ -0,0 +1,182 @@ +name = "gwf-chd" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.auxmultname] +block = "options" +name = "auxmultname" +type = "string" +reader = "urword" +optional = true +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of chd head value." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of constant-head cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprpak" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "ipakcb" + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.dev_no_newton] +block = "options" +name = "dev_no_newton" +type = "keyword" +reader = "urword" +optional = true +longname = "turn off newton for unconfined cells" +description = "turn off newton for unconfined cells" +mf6internal = "inewton" + +[dimensions.maxbound] +block = "dimensions" +name = "maxbound" +type = "integer" +reader = "urword" +optional = false +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." + +[period] +transient_block = true + +[period.stress_period_data] +block = "period" +name = "stress_period_data" +type = "list" +shape = "(maxbound)" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item] +name = "stress_period_data" +type = "record" +block = "period" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item.fields.cellid] +block = "period" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[period.stress_period_data.item.fields.head] +block = "period" +name = "head" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.aux] +block = "period" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +optional = "true" +time_series = "true" +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." +mf6internal = "auxvar" + +[period.stress_period_data.item.fields.boundname] +block = "period" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-csub.toml b/flopy/mf6/data/dfn/toml/gwf-csub.toml new file mode 100644 index 0000000000..ffb5b84760 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-csub.toml @@ -0,0 +1,696 @@ +name = "gwf-csub" +advanced = false +multi = false + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of csub cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.gammaw] +block = "options" +name = "gammaw" +type = "double precision" +default = 9806.65 +reader = "urword" +optional = true +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." + +[options.beta] +block = "options" +name = "beta" +type = "double precision" +default = 4.6512e-10 +reader = "urword" +optional = true +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." + +[options.head_based] +block = "options" +name = "head_based" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.initial_preconsolidation_head] +block = "options" +name = "initial_preconsolidation_head" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.ndelaycells] +block = "options" +name = "ndelaycells" +type = "integer" +reader = "urword" +optional = true +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." + +[options.compression_indices] +block = "options" +name = "compression_indices" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.update_material_properties] +block = "options" +name = "update_material_properties" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.cell_fraction] +block = "options" +name = "cell_fraction" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.specified_initial_interbed_state] +block = "options" +name = "specified_initial_interbed_state" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.specified_initial_preconsolidation_stress] +block = "options" +name = "specified_initial_preconsolidation_stress" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.specified_initial_delay_head] +block = "options" +name = "specified_initial_delay_head" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.effective_stress_lag] +block = "options" +name = "effective_stress_lag" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.strainib_filerecord] +block = "options" +name = "strainib_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.strainib_filerecord.fields.strain_csv_interbed] +block = "options" +name = "strain_csv_interbed" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify the record that corresponds to final interbed strain output." + +[options.strainib_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.strainib_filerecord.fields.interbedstrain_filename] +block = "options" +name = "interbedstrain_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the comma-separated-values output file to write final interbed strain information." + +[options.straincg_filerecord] +block = "options" +name = "straincg_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.straincg_filerecord.fields.strain_csv_coarse] +block = "options" +name = "strain_csv_coarse" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify the record that corresponds to final coarse-grained material strain output." + +[options.straincg_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.straincg_filerecord.fields.coarsestrain_filename] +block = "options" +name = "coarsestrain_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the comma-separated-values output file to write final coarse-grained material strain information." + +[options.compaction_filerecord] +block = "options" +name = "compaction_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.compaction_filerecord.fields.compaction] +block = "options" +name = "compaction" +type = "keyword" +reader = "urword" +optional = "false" +longname = "compaction keyword" +description = "keyword to specify that record corresponds to the compaction." + +[options.compaction_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.compaction_filerecord.fields.compaction_filename] +block = "options" +name = "compaction_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write compaction information." + +[options.compaction_elastic_filerecord] +block = "options" +name = "compaction_elastic_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.compaction_elastic_filerecord.fields.compaction_elastic] +block = "options" +name = "compaction_elastic" +type = "keyword" +reader = "urword" +optional = "false" +longname = "elastic interbed compaction keyword" +description = "keyword to specify that record corresponds to the elastic interbed compaction binary file." + +[options.compaction_elastic_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.compaction_elastic_filerecord.fields.elastic_compaction_filename] +block = "options" +name = "elastic_compaction_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write elastic interbed compaction information." + +[options.compaction_inelastic_filerecord] +block = "options" +name = "compaction_inelastic_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.compaction_inelastic_filerecord.fields.compaction_inelastic] +block = "options" +name = "compaction_inelastic" +type = "keyword" +reader = "urword" +optional = "false" +longname = "inelastic interbed compaction keyword" +description = "keyword to specify that record corresponds to the inelastic interbed compaction binary file." + +[options.compaction_inelastic_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.compaction_inelastic_filerecord.fields.inelastic_compaction_filename] +block = "options" +name = "inelastic_compaction_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write inelastic interbed compaction information." + +[options.compaction_interbed_filerecord] +block = "options" +name = "compaction_interbed_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.compaction_interbed_filerecord.fields.compaction_interbed] +block = "options" +name = "compaction_interbed" +type = "keyword" +reader = "urword" +optional = "false" +longname = "interbed compaction keyword" +description = "keyword to specify that record corresponds to the interbed compaction binary file." + +[options.compaction_interbed_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.compaction_interbed_filerecord.fields.interbed_compaction_filename] +block = "options" +name = "interbed_compaction_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write interbed compaction information." + +[options.compaction_coarse_filerecord] +block = "options" +name = "compaction_coarse_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.compaction_coarse_filerecord.fields.compaction_coarse] +block = "options" +name = "compaction_coarse" +type = "keyword" +reader = "urword" +optional = "false" +longname = "coarse compaction keyword" +description = "keyword to specify that record corresponds to the elastic coarse-grained material compaction binary file." + +[options.compaction_coarse_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.compaction_coarse_filerecord.fields.coarse_compaction_filename] +block = "options" +name = "coarse_compaction_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write elastic coarse-grained material compaction information." + +[options.zdisplacement_filerecord] +block = "options" +name = "zdisplacement_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.zdisplacement_filerecord.fields.zdisplacement] +block = "options" +name = "zdisplacement" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the z-displacement binary file." + +[options.zdisplacement_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.zdisplacement_filerecord.fields.zdisplacement_filename] +block = "options" +name = "zdisplacement_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write z-displacement information." + +[options.package_convergence_filerecord] +block = "options" +name = "package_convergence_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.package_convergence_filerecord.fields.package_convergence] +block = "options" +name = "package_convergence" +type = "keyword" +reader = "urword" +optional = "false" +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." + +[options.package_convergence_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.package_convergence_filerecord.fields.package_convergence_filename] +block = "options" +name = "package_convergence_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[dimensions.ninterbeds] +block = "dimensions" +name = "ninterbeds" +type = "integer" +reader = "urword" +optional = false +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." + +[dimensions.maxsig0] +block = "dimensions" +name = "maxsig0" +type = "integer" +reader = "urword" +optional = true +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." + +[griddata.cg_ske_cr] +block = "griddata" +name = "cg_ske_cr" +type = "double precision" +shape = "(nodes)" +default = 1e-05 +reader = "readarray" +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." + +[griddata.cg_theta] +block = "griddata" +name = "cg_theta" +type = "double precision" +shape = "(nodes)" +default = 0.2 +reader = "readarray" +longname = "initial coarse-grained material porosity" +description = "is the initial porosity of coarse-grained materials." + +[griddata.sgm] +block = "griddata" +name = "sgm" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." + +[griddata.sgs] +block = "griddata" +name = "sgs" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(ninterbeds)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.icsubno] +block = "packagedata" +name = "icsubno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.cellid] +block = "period" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.cdelay] +block = "packagedata" +name = "cdelay" +type = "string" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.pcs0] +block = "packagedata" +name = "pcs0" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.thick_frac] +block = "packagedata" +name = "thick_frac" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.rnb] +block = "packagedata" +name = "rnb" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.ssv_cc] +block = "packagedata" +name = "ssv_cc" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.sse_cr] +block = "packagedata" +name = "sse_cr" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.theta] +block = "packagedata" +name = "theta" +type = "double precision" +reader = "urword" +longname = "initial interbed porosity" +description = "is the initial porosity of the interbed." +default = "0.2" + +[packagedata.packagedata.item.fields.kv] +block = "packagedata" +name = "kv" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.h0] +block = "packagedata" +name = "h0" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.boundname] +block = "packagedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +longname = "well 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." + +[period] +transient_block = true + +[period.stress_period_data] +block = "period" +name = "stress_period_data" +type = "list" +shape = "(maxsig0)" +reader = "urword" + +[period.stress_period_data.item] +name = "stress_period_data" +type = "record" +block = "period" +reader = "urword" + +[period.stress_period_data.item.fields.cellid] +block = "period" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[period.stress_period_data.item.fields.sig0] +block = "period" +name = "sig0" +type = "double precision" +reader = "urword" +time_series = "true" +longname = "well 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." diff --git a/flopy/mf6/data/dfn/toml/gwf-dis.toml b/flopy/mf6/data/dfn/toml/gwf-dis.toml new file mode 100644 index 0000000000..f87c38bbc6 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-dis.toml @@ -0,0 +1,214 @@ +name = "gwf-dis" +advanced = false +multi = false + +[fkeys.ncf_filerecord] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[options.length_units] +block = "options" +name = "length_units" +type = "string" +reader = "urword" +optional = true +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'." + +[options.nogrb] +block = "options" +name = "nogrb" +type = "keyword" +reader = "urword" +optional = true +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." + +[options.grb_filerecord] +block = "options" +name = "grb_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.grb_filerecord.fields.grb6] +block = "options" +name = "grb6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." +extended = "true" + +[options.grb_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.grb_filerecord.fields.grb6_filename] +block = "options" +name = "grb6_filename" +type = "string" +reader = "urword" +optional = "false" +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'." +extended = "true" + +[options.xorigin] +block = "options" +name = "xorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.yorigin] +block = "options" +name = "yorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.angrot] +block = "options" +name = "angrot" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[options.packagedata] +block = "options" +name = "packagedata" +type = "record ncf6 filein ncf6_filename" +reader = "urword" +optional = true +description = "Contains data for the ncf package. Data can be passed as a dictionary to the ncf package with variable names as keys and package data as values. Data for the packagedata variable is also acceptable. See ncf package documentation for more information." + +[options.packagedata.ref] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[dimensions.nlay] +block = "dimensions" +name = "nlay" +type = "integer" +default = 1 +reader = "urword" +optional = false +longname = "number of layers" +description = "is the number of layers in the model grid." + +[dimensions.nrow] +block = "dimensions" +name = "nrow" +type = "integer" +default = 2 +reader = "urword" +optional = false +longname = "number of rows" +description = "is the number of rows in the model grid." + +[dimensions.ncol] +block = "dimensions" +name = "ncol" +type = "integer" +default = 2 +reader = "urword" +optional = false +longname = "number of columns" +description = "is the number of columns in the model grid." + +[griddata.delr] +block = "griddata" +name = "delr" +type = "double precision" +shape = "(ncol)" +default = 1.0 +reader = "readarray" +longname = "spacing along a row" +description = "is the column spacing in the row direction." +netcdf = true + +[griddata.delc] +block = "griddata" +name = "delc" +type = "double precision" +shape = "(nrow)" +default = 1.0 +reader = "readarray" +longname = "spacing along a column" +description = "is the row spacing in the column direction." +netcdf = true + +[griddata.top] +block = "griddata" +name = "top" +type = "double precision" +shape = "(ncol, nrow)" +default = 1.0 +reader = "readarray" +longname = "cell top elevation" +description = "is the top elevation for each cell in the top model layer." +netcdf = true + +[griddata.botm] +block = "griddata" +name = "botm" +type = "double precision" +shape = "(ncol, nrow, nlay)" +default = 0.0 +reader = "readarray" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." +layered = true +netcdf = true + +[griddata.idomain] +block = "griddata" +name = "idomain" +type = "integer" +shape = "(ncol, nrow, nlay)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true diff --git a/flopy/mf6/data/dfn/toml/gwf-disu.toml b/flopy/mf6/data/dfn/toml/gwf-disu.toml new file mode 100644 index 0000000000..c57634705c --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-disu.toml @@ -0,0 +1,341 @@ +name = "gwf-disu" +advanced = false +multi = false + +[options.length_units] +block = "options" +name = "length_units" +type = "string" +reader = "urword" +optional = true +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'." + +[options.nogrb] +block = "options" +name = "nogrb" +type = "keyword" +reader = "urword" +optional = true +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." + +[options.grb_filerecord] +block = "options" +name = "grb_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.grb_filerecord.fields.grb6] +block = "options" +name = "grb6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." +extended = "true" + +[options.grb_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.grb_filerecord.fields.grb6_filename] +block = "options" +name = "grb6_filename" +type = "string" +reader = "urword" +optional = "false" +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'." +extended = "true" + +[options.xorigin] +block = "options" +name = "xorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.yorigin] +block = "options" +name = "yorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.angrot] +block = "options" +name = "angrot" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.vertical_offset_tolerance] +block = "options" +name = "vertical_offset_tolerance" +type = "double precision" +default = 0.0 +reader = "urword" +optional = true +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." +mf6internal = "voffsettol" + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[dimensions.nodes] +block = "dimensions" +name = "nodes" +type = "integer" +reader = "urword" +optional = false +longname = "number of layers" +description = "is the number of cells in the model grid." + +[dimensions.nja] +block = "dimensions" +name = "nja" +type = "integer" +reader = "urword" +optional = false +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." + +[dimensions.nvert] +block = "dimensions" +name = "nvert" +type = "integer" +reader = "urword" +optional = true +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." + +[griddata.top] +block = "griddata" +name = "top" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +longname = "cell top elevation" +description = "is the top elevation for each cell in the model grid." + +[griddata.bot] +block = "griddata" +name = "bot" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." + +[griddata.area] +block = "griddata" +name = "area" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +longname = "cell surface area" +description = "is the cell surface area (in plan view)." + +[griddata.idomain] +block = "griddata" +name = "idomain" +type = "integer" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = false + +[connectiondata.iac] +block = "connectiondata" +name = "iac" +type = "integer" +shape = "(nodes)" +reader = "readarray" +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." + +[connectiondata.ja] +block = "connectiondata" +name = "ja" +type = "integer" +shape = "(nja)" +reader = "readarray" +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." +numeric_index = true +jagged_array = "iac" + +[connectiondata.ihc] +block = "connectiondata" +name = "ihc" +type = "integer" +shape = "(nja)" +reader = "readarray" +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." +jagged_array = "iac" + +[connectiondata.cl12] +block = "connectiondata" +name = "cl12" +type = "double precision" +shape = "(nja)" +reader = "readarray" +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." +jagged_array = "iac" + +[connectiondata.hwva] +block = "connectiondata" +name = "hwva" +type = "double precision" +shape = "(nja)" +reader = "readarray" +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." +jagged_array = "iac" + +[connectiondata.angldegx] +block = "connectiondata" +name = "angldegx" +type = "double precision" +shape = "(nja)" +reader = "readarray" +optional = true +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." +jagged_array = "iac" + +[vertices.vertices] +block = "vertices" +name = "vertices" +type = "list" +shape = "(nvert)" +reader = "urword" +optional = true +longname = "vertices data" + +[vertices.vertices.item] +name = "vertices" +type = "record" +block = "vertices" +reader = "urword" +optional = true +longname = "vertices data" + +[vertices.vertices.item.fields.iv] +block = "vertices" +name = "iv" +type = "integer" +reader = "urword" +optional = "false" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +numeric_index = "true" + +[vertices.vertices.item.fields.xv] +block = "vertices" +name = "xv" +type = "double precision" +reader = "urword" +optional = "false" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." + +[vertices.vertices.item.fields.yv] +block = "vertices" +name = "yv" +type = "double precision" +reader = "urword" +optional = "false" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." + +[cell2d.cell2d] +block = "cell2d" +name = "cell2d" +type = "list" +shape = "(nodes)" +reader = "urword" +optional = true +longname = "cell2d data" + +[cell2d.cell2d.item] +name = "cell2d" +type = "record" +block = "cell2d" +reader = "urword" +optional = true +longname = "cell2d data" + +[cell2d.cell2d.item.fields.icell2d] +block = "cell2d" +name = "icell2d" +type = "integer" +reader = "urword" +optional = "false" +longname = "cell2d number" +description = "is the cell2d number. Records in the CELL2D block must be listed in consecutive order from 1 to NODES." +numeric_index = "true" + +[cell2d.cell2d.item.fields.xc] +block = "cell2d" +name = "xc" +type = "double precision" +reader = "urword" +optional = "false" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." + +[cell2d.cell2d.item.fields.yc] +block = "cell2d" +name = "yc" +type = "double precision" +reader = "urword" +optional = "false" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." + +[cell2d.cell2d.item.fields.ncvert] +block = "cell2d" +name = "ncvert" +type = "integer" +reader = "urword" +optional = "false" +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." + +[cell2d.cell2d.item.fields.icvert] +block = "cell2d" +name = "icvert" +type = "integer" +shape = "(ncvert)" +reader = "urword" +optional = "false" +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." +numeric_index = "true" diff --git a/flopy/mf6/data/dfn/toml/gwf-disv.toml b/flopy/mf6/data/dfn/toml/gwf-disv.toml new file mode 100644 index 0000000000..45d5d067c8 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-disv.toml @@ -0,0 +1,297 @@ +name = "gwf-disv" +advanced = false +multi = false + +[fkeys.ncf_filerecord] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[options.length_units] +block = "options" +name = "length_units" +type = "string" +reader = "urword" +optional = true +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'." + +[options.nogrb] +block = "options" +name = "nogrb" +type = "keyword" +reader = "urword" +optional = true +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." + +[options.grb_filerecord] +block = "options" +name = "grb_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.grb_filerecord.fields.grb6] +block = "options" +name = "grb6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." +extended = "true" + +[options.grb_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.grb_filerecord.fields.grb6_filename] +block = "options" +name = "grb6_filename" +type = "string" +reader = "urword" +optional = "false" +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'." +extended = "true" + +[options.xorigin] +block = "options" +name = "xorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.yorigin] +block = "options" +name = "yorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.angrot] +block = "options" +name = "angrot" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[options.packagedata] +block = "options" +name = "packagedata" +type = "record ncf6 filein ncf6_filename" +reader = "urword" +optional = true +description = "Contains data for the ncf package. Data can be passed as a dictionary to the ncf package with variable names as keys and package data as values. Data for the packagedata variable is also acceptable. See ncf package documentation for more information." + +[options.packagedata.ref] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[dimensions.nlay] +block = "dimensions" +name = "nlay" +type = "integer" +reader = "urword" +optional = false +longname = "number of layers" +description = "is the number of layers in the model grid." + +[dimensions.ncpl] +block = "dimensions" +name = "ncpl" +type = "integer" +reader = "urword" +optional = false +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." + +[dimensions.nvert] +block = "dimensions" +name = "nvert" +type = "integer" +reader = "urword" +optional = false +longname = "number of columns" +description = "is the total number of (x, y) vertex pairs used to characterize the horizontal configuration of the model grid." + +[griddata.top] +block = "griddata" +name = "top" +type = "double precision" +shape = "(ncpl)" +reader = "readarray" +longname = "model top elevation" +description = "is the top elevation for each cell in the top model layer." +netcdf = true + +[griddata.botm] +block = "griddata" +name = "botm" +type = "double precision" +shape = "(ncpl, nlay)" +reader = "readarray" +longname = "model bottom elevation" +description = "is the bottom elevation for each cell." +layered = true +netcdf = true + +[griddata.idomain] +block = "griddata" +name = "idomain" +type = "integer" +shape = "(ncpl, nlay)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[vertices.vertices] +block = "vertices" +name = "vertices" +type = "list" +shape = "(nvert)" +reader = "urword" +optional = false +longname = "vertices data" + +[vertices.vertices.item] +name = "vertices" +type = "record" +block = "vertices" +reader = "urword" +optional = false +longname = "vertices data" + +[vertices.vertices.item.fields.iv] +block = "vertices" +name = "iv" +type = "integer" +reader = "urword" +optional = "false" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +numeric_index = "true" + +[vertices.vertices.item.fields.xv] +block = "vertices" +name = "xv" +type = "double precision" +reader = "urword" +optional = "false" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." + +[vertices.vertices.item.fields.yv] +block = "vertices" +name = "yv" +type = "double precision" +reader = "urword" +optional = "false" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." + +[cell2d.cell2d] +block = "cell2d" +name = "cell2d" +type = "list" +shape = "(ncpl)" +reader = "urword" +optional = false +longname = "cell2d data" + +[cell2d.cell2d.item] +name = "cell2d" +type = "record" +block = "cell2d" +reader = "urword" +optional = false +longname = "cell2d data" + +[cell2d.cell2d.item.fields.icell2d] +block = "cell2d" +name = "icell2d" +type = "integer" +reader = "urword" +optional = "false" +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." +numeric_index = "true" + +[cell2d.cell2d.item.fields.xc] +block = "cell2d" +name = "xc" +type = "double precision" +reader = "urword" +optional = "false" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." + +[cell2d.cell2d.item.fields.yc] +block = "cell2d" +name = "yc" +type = "double precision" +reader = "urword" +optional = "false" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." + +[cell2d.cell2d.item.fields.ncvert] +block = "cell2d" +name = "ncvert" +type = "integer" +reader = "urword" +optional = "false" +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." + +[cell2d.cell2d.item.fields.icvert] +block = "cell2d" +name = "icvert" +type = "integer" +shape = "(ncvert)" +reader = "urword" +optional = "false" +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." +numeric_index = "true" diff --git a/flopy/mf6/data/dfn/toml/gwf-drn.toml b/flopy/mf6/data/dfn/toml/gwf-drn.toml new file mode 100644 index 0000000000..64633dd93f --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-drn.toml @@ -0,0 +1,208 @@ +name = "gwf-drn" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.auxmultname] +block = "options" +name = "auxmultname" +type = "string" +reader = "urword" +optional = true +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of drain conductance." + +[options.auxdepthname] +block = "options" +name = "auxdepthname" +type = "string" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of drain cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprpak" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +longname = "save chd 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." +mf6internal = "ipakcb" + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.mover] +block = "options" +name = "mover" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.dev_cubic_scaling] +block = "options" +name = "dev_cubic_scaling" +type = "keyword" +reader = "urword" +optional = true +longname = "cubic-scaling" +description = "cubic-scaling is used to scale the drain conductance" +mf6internal = "icubicsfac" + +[dimensions.maxbound] +block = "dimensions" +name = "maxbound" +type = "integer" +reader = "urword" +optional = false +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." + +[period] +transient_block = true + +[period.stress_period_data] +block = "period" +name = "stress_period_data" +type = "list" +shape = "(maxbound)" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item] +name = "stress_period_data" +type = "record" +block = "period" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item.fields.cellid] +block = "period" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[period.stress_period_data.item.fields.elev] +block = "period" +name = "elev" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.cond] +block = "period" +name = "cond" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.aux] +block = "period" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +optional = "true" +time_series = "true" +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." +mf6internal = "auxvar" + +[period.stress_period_data.item.fields.boundname] +block = "period" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-evt.toml b/flopy/mf6/data/dfn/toml/gwf-evt.toml new file mode 100644 index 0000000000..4f7e3ae80c --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-evt.toml @@ -0,0 +1,250 @@ +name = "gwf-evt" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.fixed_cell] +block = "options" +name = "fixed_cell" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.auxmultname] +block = "options" +name = "auxmultname" +type = "string" +reader = "urword" +optional = true +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of evapotranspiration rate." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of evapotranspiration cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprpak" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "ipakcb" + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.surf_rate_specified] +block = "options" +name = "surf_rate_specified" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "surfratespec" + +[dimensions.maxbound] +block = "dimensions" +name = "maxbound" +type = "integer" +reader = "urword" +optional = false +longname = "maximum number of evapotranspiration cells" +description = "integer value specifying the maximum number of evapotranspiration cells cells that will be specified for use during any stress period." + +[dimensions.nseg] +block = "dimensions" +name = "nseg" +type = "integer" +reader = "urword" +optional = false +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." + +[period] +transient_block = true + +[period.stress_period_data] +block = "period" +name = "stress_period_data" +type = "list" +shape = "(maxbound)" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item] +name = "stress_period_data" +type = "record" +block = "period" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item.fields.cellid] +block = "period" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[period.stress_period_data.item.fields.surface] +block = "period" +name = "surface" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.rate] +block = "period" +name = "rate" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.depth] +block = "period" +name = "depth" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.pxdp] +block = "period" +name = "pxdp" +type = "double precision" +shape = "(nseg-1)" +reader = "urword" +optional = "true" +time_series = "true" +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." + +[period.stress_period_data.item.fields.petm] +block = "period" +name = "petm" +type = "double precision" +shape = "(nseg-1)" +reader = "urword" +optional = "true" +time_series = "true" +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." + +[period.stress_period_data.item.fields.petm0] +block = "period" +name = "petm0" +type = "double precision" +reader = "urword" +optional = "true" +time_series = "true" +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." + +[period.stress_period_data.item.fields.aux] +block = "period" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +optional = "true" +time_series = "true" +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." +mf6internal = "auxvar" + +[period.stress_period_data.item.fields.boundname] +block = "period" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-evta.toml b/flopy/mf6/data/dfn/toml/gwf-evta.toml new file mode 100644 index 0000000000..e8301a0412 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-evta.toml @@ -0,0 +1,182 @@ +name = "gwf-evta" +advanced = false +multi = true + +[fkeys.tas_filerecord] +parent = "parent_package" +key = "tas_filerecord" +val = "timearrayseries" +abbr = "tas" +param = "tas_array" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.readasarrays] +block = "options" +name = "readasarrays" +type = "keyword" +default = true +reader = "urword" +optional = false +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." + +[options.fixed_cell] +block = "options" +name = "fixed_cell" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.auxmultname] +block = "options" +name = "auxmultname" +type = "string" +reader = "urword" +optional = true +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of evapotranspiration rate." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprpak" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +longname = "save chd 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." +mf6internal = "ipakcb" + +[options.timearrayseries] +block = "options" +name = "timearrayseries" +type = "record tas6 filein tas6_filename" +reader = "urword" +optional = true +description = "Contains data for the tas package. Data can be passed as a dictionary to the tas package with variable names as keys and package data as values. Data for the timearrayseries variable is also acceptable. See tas package documentation for more information." + +[options.timearrayseries.ref] +parent = "parent_package" +key = "tas_filerecord" +val = "timearrayseries" +abbr = "tas" +param = "tas_array" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[period] +transient_block = true + +[period.ievt] +block = "period" +name = "ievt" +type = "integer" +shape = "(ncol*nrow; ncpl)" +reader = "readarray" +optional = true +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." +numeric_index = true + +[period.surface] +block = "period" +name = "surface" +type = "double precision" +shape = "(ncol*nrow; ncpl)" +default = 0.0 +reader = "readarray" +longname = "evapotranspiration surface" +description = "is the elevation of the et surface ($l$)." + +[period.rate] +block = "period" +name = "rate" +type = "double precision" +shape = "(ncol*nrow; ncpl)" +default = 0.001 +reader = "readarray" +longname = "evapotranspiration surface" +description = "is the maximum et flux rate ($lt^{-1}$)." +time_series = true + +[period.depth] +block = "period" +name = "depth" +type = "double precision" +shape = "(ncol*nrow; ncpl)" +default = 1.0 +reader = "readarray" +longname = "extinction depth" +description = "is the et extinction depth ($l$)." + +[period.aux] +block = "period" +name = "aux" +type = "double precision" +shape = "(ncol*nrow; ncpl)" +reader = "readarray" +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 a value of zero is assigned. if the value specified here for the auxiliary variable is the same as auxmultname, then the evapotranspiration rate will be multiplied by this array." +time_series = true +mf6internal = "auxvar" diff --git a/flopy/mf6/data/dfn/toml/gwf-ghb.toml b/flopy/mf6/data/dfn/toml/gwf-ghb.toml new file mode 100644 index 0000000000..f11a4f4bb3 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-ghb.toml @@ -0,0 +1,189 @@ +name = "gwf-ghb" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.auxmultname] +block = "options" +name = "auxmultname" +type = "string" +reader = "urword" +optional = true +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of general-head boundary conductance." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of general-head boundary cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprpak" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +longname = "save chd 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." +mf6internal = "ipakcb" + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.mover] +block = "options" +name = "mover" +type = "keyword" +reader = "urword" +optional = true +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." + +[dimensions.maxbound] +block = "dimensions" +name = "maxbound" +type = "integer" +reader = "urword" +optional = false +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." + +[period] +transient_block = true + +[period.stress_period_data] +block = "period" +name = "stress_period_data" +type = "list" +shape = "(maxbound)" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item] +name = "stress_period_data" +type = "record" +block = "period" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item.fields.cellid] +block = "period" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[period.stress_period_data.item.fields.bhead] +block = "period" +name = "bhead" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.cond] +block = "period" +name = "cond" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.aux] +block = "period" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +optional = "true" +time_series = "true" +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." +mf6internal = "auxvar" + +[period.stress_period_data.item.fields.boundname] +block = "period" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-gnc.toml b/flopy/mf6/data/dfn/toml/gwf-gnc.toml new file mode 100644 index 0000000000..9270e66162 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-gnc.toml @@ -0,0 +1,105 @@ +name = "gwf-gnc" +advanced = false +multi = false + +[ref] +parent = "parent_model_or_package" +key = "gnc_filerecord" +val = "gncdata" +abbr = "gnc" +param = "gncdata" + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.explicit] +block = "options" +name = "explicit" +type = "keyword" +reader = "urword" +optional = true +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." + +[dimensions.numgnc] +block = "dimensions" +name = "numgnc" +type = "integer" +reader = "urword" +optional = false +longname = "number of ghost node corrections" +description = "is the number of gnc entries." + +[dimensions.numalphaj] +block = "dimensions" +name = "numalphaj" +type = "integer" +reader = "urword" +optional = false +longname = "number of contributing factors" +description = "is the number of contributing factors." + +[gncdata.gncdata] +block = "gncdata" +name = "gncdata" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[gncdata.gncdata.item] +name = "gncdata" +type = "record" +block = "gncdata" +reader = "urword" + +[gncdata.gncdata.item.fields.cellidn] +block = "gncdata" +name = "cellidn" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[gncdata.gncdata.item.fields.cellidm] +block = "gncdata" +name = "cellidm" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[gncdata.gncdata.item.fields.cellidsj] +block = "gncdata" +name = "cellidsj" +type = "integer" +shape = "(numalphaj)" +reader = "urword" +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." +numeric_index = "true" + +[gncdata.gncdata.item.fields.alphasj] +block = "gncdata" +name = "alphasj" +type = "double precision" +shape = "(numalphaj)" +reader = "urword" +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-hfb.toml b/flopy/mf6/data/dfn/toml/gwf-hfb.toml new file mode 100644 index 0000000000..e935b3798e --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-hfb.toml @@ -0,0 +1,63 @@ +name = "gwf-hfb" +advanced = false +multi = false + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +longname = "model print input to listing file" +description = "keyword to indicate that the list of horizontal flow barriers will be written to the listing file immediately after it is read." + +[dimensions.maxhfb] +block = "dimensions" +name = "maxhfb" +type = "integer" +reader = "urword" +optional = false +longname = "maximum number of barriers" +description = "integer value specifying the maximum number of horizontal flow barriers that will be entered in this input file. the value of maxhfb is used to allocate memory for the horizontal flow barriers." + +[period] +transient_block = true + +[period.stress_period_data] +block = "period" +name = "stress_period_data" +type = "list" +shape = "(maxhfb)" +reader = "urword" + +[period.stress_period_data.item] +name = "stress_period_data" +type = "record" +block = "period" +reader = "urword" + +[period.stress_period_data.item.fields.cellid1] +block = "period" +name = "cellid1" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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 numbers for the cell. The barrier is located between cells designated as CELLID1 and CELLID2. For models that use the DIS and DISV grid types, the layer number for CELLID1 and CELLID2 must be the same. For all grid types, cells must be horizontally adjacent or the program will terminate with an error." + +[period.stress_period_data.item.fields.cellid2] +block = "period" +name = "cellid2" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +longname = "second cell adjacent to barrier" +description = "identifier for the second cell. See CELLID1 for description of how to specify." + +[period.stress_period_data.item.fields.hydchr] +block = "period" +name = "hydchr" +type = "double precision" +reader = "urword" +longname = "barrier hydraulic characteristic" +description = "is the hydraulic characteristic of the horizontal-flow barrier. The hydraulic characteristic is the barrier hydraulic conductivity divided by the width of the horizontal-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." diff --git a/flopy/mf6/data/dfn/toml/gwf-ic.toml b/flopy/mf6/data/dfn/toml/gwf-ic.toml new file mode 100644 index 0000000000..8eb95657e5 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-ic.toml @@ -0,0 +1,36 @@ +name = "gwf-ic" +advanced = false +multi = false + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[griddata.strt] +block = "griddata" +name = "strt" +type = "double precision" +shape = "(nodes)" +default = 1.0 +reader = "readarray" +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." +layered = true +netcdf = true diff --git a/flopy/mf6/data/dfn/toml/gwf-lak.toml b/flopy/mf6/data/dfn/toml/gwf-lak.toml new file mode 100644 index 0000000000..07e7fa0ba8 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-lak.toml @@ -0,0 +1,765 @@ +name = "gwf-lak" +advanced = true +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of lake cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_stage] +block = "options" +name = "print_stage" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.stage_filerecord] +block = "options" +name = "stage_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.stage_filerecord.fields.stage] +block = "period" +name = "stage" +type = "string" +time_series = "true" +reader = "urword" +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." + +[options.stage_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.stage_filerecord.fields.stagefile] +block = "options" +name = "stagefile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write stage information." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.package_convergence_filerecord] +block = "options" +name = "package_convergence_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.package_convergence_filerecord.fields.package_convergence] +block = "options" +name = "package_convergence" +type = "keyword" +reader = "urword" +optional = "false" +longname = "package_convergence keyword" +description = "keyword to specify that record corresponds to the package convergence comma spaced values file." + +[options.package_convergence_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.package_convergence_filerecord.fields.package_convergence_filename] +block = "options" +name = "package_convergence_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.mover] +block = "options" +name = "mover" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.surfdep] +block = "options" +name = "surfdep" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.maximum_iterations] +block = "options" +name = "maximum_iterations" +type = "integer" +reader = "urword" +optional = true +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." + +[options.maximum_stage_change] +block = "options" +name = "maximum_stage_change" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.time_conversion] +block = "options" +name = "time_conversion" +type = "double precision" +reader = "urword" +optional = true +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. convtime does not need to be specified if no lake outlets are specified or time_units are seconds." + +[options.length_conversion] +block = "options" +name = "length_conversion" +type = "double precision" +reader = "urword" +optional = true +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." + +[dimensions.nlakes] +block = "dimensions" +name = "nlakes" +type = "integer" +reader = "urword" +optional = false +longname = "number of lakes" +description = "value specifying the number of lakes that will be simulated for all stress periods." + +[dimensions.noutlets] +block = "dimensions" +name = "noutlets" +type = "integer" +reader = "urword" +optional = false +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." + +[dimensions.ntables] +block = "dimensions" +name = "ntables" +type = "integer" +reader = "urword" +optional = false +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." + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.ifno] +block = "tables" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.strt] +block = "packagedata" +name = "strt" +type = "double precision" +reader = "urword" +longname = "starting lake stage" +description = "real value that defines the starting stage for the lake." + +[packagedata.packagedata.item.fields.nlakeconn] +block = "packagedata" +name = "nlakeconn" +type = "integer" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.aux] +block = "packagedata" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +time_series = "true" +optional = "true" +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." + +[packagedata.packagedata.item.fields.boundname] +block = "packagedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." + +[connectiondata.connectiondata] +block = "connectiondata" +name = "connectiondata" +type = "list" +shape = "(sum(nlakeconn))" +reader = "urword" + +[connectiondata.connectiondata.item] +name = "connectiondata" +type = "record" +block = "connectiondata" +reader = "urword" + +[connectiondata.connectiondata.item.fields.ifno] +block = "tables" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[connectiondata.connectiondata.item.fields.iconn] +block = "connectiondata" +name = "iconn" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[connectiondata.connectiondata.item.fields.cellid] +block = "connectiondata" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[connectiondata.connectiondata.item.fields.claktype] +block = "connectiondata" +name = "claktype" +type = "string" +reader = "urword" +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." + +[connectiondata.connectiondata.item.fields.bedleak] +block = "connectiondata" +name = "bedleak" +type = "string" +reader = "urword" +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." + +[connectiondata.connectiondata.item.fields.belev] +block = "connectiondata" +name = "belev" +type = "double precision" +reader = "urword" +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." + +[connectiondata.connectiondata.item.fields.telev] +block = "connectiondata" +name = "telev" +type = "double precision" +reader = "urword" +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." + +[connectiondata.connectiondata.item.fields.connlen] +block = "connectiondata" +name = "connlen" +type = "double precision" +reader = "urword" +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." + +[connectiondata.connectiondata.item.fields.connwidth] +block = "connectiondata" +name = "connwidth" +type = "double precision" +reader = "urword" +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." + +[tables.tables] +block = "tables" +name = "tables" +type = "list" +shape = "(ntables)" +reader = "urword" + +[tables.tables.item] +name = "tables" +type = "record" +block = "tables" +reader = "urword" + +[tables.tables.item.fields.ifno] +block = "tables" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[tables.tables.item.fields.tab6] +block = "tables" +name = "tab6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "head keyword" +description = "keyword to specify that record corresponds to a table file." + +[tables.tables.item.fields.filein] +block = "tables" +name = "filein" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an input filename is expected next." + +[tables.tables.item.fields.tab6_filename] +block = "tables" +name = "tab6_filename" +type = "string" +reader = "urword" +optional = "false" +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." + +[outlets.outlets] +block = "outlets" +name = "outlets" +type = "list" +shape = "(noutlets)" +reader = "urword" + +[outlets.outlets.item] +name = "outlets" +type = "record" +block = "outlets" +reader = "urword" + +[outlets.outlets.item.fields.outletno] +block = "outlets" +name = "outletno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[outlets.outlets.item.fields.lakein] +block = "outlets" +name = "lakein" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[outlets.outlets.item.fields.lakeout] +block = "outlets" +name = "lakeout" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[outlets.outlets.item.fields.couttype] +block = "outlets" +name = "couttype" +type = "string" +reader = "urword" +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." + +[outlets.outlets.item.fields.invert] +block = "period" +name = "invert" +type = "string" +reader = "urword" +time_series = "true" +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." + +[outlets.outlets.item.fields.width] +block = "period" +name = "width" +type = "string" +reader = "urword" +time_series = "true" +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." + +[outlets.outlets.item.fields.rough] +block = "period" +name = "rough" +type = "string" +reader = "urword" +time_series = "true" +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." + +[outlets.outlets.item.fields.slope] +block = "period" +name = "slope" +type = "string" +reader = "urword" +time_series = "true" +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." + +[period] +transient_block = true + +[period.perioddata] +block = "period" +name = "perioddata" +type = "list" +reader = "urword" + +[period.perioddata.item] +name = "perioddata" +type = "record" +block = "period" +reader = "urword" + +[period.perioddata.item.fields.number] +block = "period" +name = "number" +type = "integer" +reader = "urword" +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." +numeric_index = true + +[period.perioddata.item.fields.laksetting] +block = "period" +name = "laksetting" +type = "union" +reader = "urword" +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." + +[period.perioddata.item.fields.laksetting.choices.stage] +block = "period" +name = "stage" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.laksetting.choices.invert] +block = "period" +name = "invert" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.laksetting.choices.width] +block = "period" +name = "width" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.laksetting.choices.rough] +block = "period" +name = "rough" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.laksetting.choices.slope] +block = "period" +name = "slope" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.laksetting.choices.status] +block = "period" +name = "status" +type = "string" +reader = "urword" +longname = "lake status" +description = "keyword option to define lake status. status can be active, inactive, or constant. by default, status is active." + +[period.perioddata.item.fields.laksetting.choices.rainfall] +block = "period" +name = "rainfall" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.laksetting.choices.evaporation] +block = "period" +name = "evaporation" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.laksetting.choices.runoff] +block = "period" +name = "runoff" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.laksetting.choices.inflow] +block = "period" +name = "inflow" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.laksetting.choices.withdrawal] +block = "period" +name = "withdrawal" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.laksetting.choices.rate] +block = "period" +name = "rate" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.laksetting.choices.auxiliaryrecord] +block = "period" +name = "auxiliaryrecord" +type = "record" +reader = "urword" + +[period.perioddata.item.fields.laksetting.choices.auxiliaryrecord.fields.auxiliary] +block = "period" +name = "auxiliary" +type = "keyword" +reader = "urword" +description = "keyword for specifying auxiliary variable." + +[period.perioddata.item.fields.laksetting.choices.auxiliaryrecord.fields.auxname] +block = "period" +name = "auxname" +type = "string" +reader = "urword" +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." + +[period.perioddata.item.fields.laksetting.choices.auxiliaryrecord.fields.auxval] +block = "period" +name = "auxval" +type = "double precision" +reader = "urword" +time_series = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-maw.toml b/flopy/mf6/data/dfn/toml/gwf-maw.toml new file mode 100644 index 0000000000..d856ecbd89 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-maw.toml @@ -0,0 +1,645 @@ +name = "gwf-maw" +advanced = true +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of multi-aquifer well cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_head] +block = "options" +name = "print_head" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.head_filerecord] +block = "options" +name = "head_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.head_filerecord.fields.head] +block = "options" +name = "head" +type = "keyword" +reader = "urword" +optional = "false" +longname = "head keyword" +description = "keyword to specify that record corresponds to head." + +[options.head_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.head_filerecord.fields.headfile] +block = "options" +name = "headfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write head information." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.no_well_storage] +block = "options" +name = "no_well_storage" +type = "keyword" +reader = "urword" +optional = true +longname = "deactivate well storage" +description = "keyword that deactivates inclusion of well storage contributions to the multi-aquifer well package continuity equation." + +[options.flow_correction] +block = "options" +name = "flow_correction" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.flowing_wells] +block = "options" +name = "flowing_wells" +type = "keyword" +reader = "urword" +optional = true +longname = "activate flowing wells" +description = "keyword that activates the flowing wells option for the multi-aquifer well package." + +[options.shutdown_theta] +block = "options" +name = "shutdown_theta" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.shutdown_kappa] +block = "options" +name = "shutdown_kappa" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.mfrcsv_filerecord] +block = "options" +name = "mfrcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.mfrcsv_filerecord.fields.maw_flow_reduce_csv] +block = "options" +name = "maw_flow_reduce_csv" +type = "keyword" +reader = "urword" +optional = "false" +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." + +[options.mfrcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.mfrcsv_filerecord.fields.mfrcsvfile] +block = "options" +name = "mfrcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.mover] +block = "options" +name = "mover" +type = "keyword" +reader = "urword" +optional = true +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." + +[dimensions.nmawwells] +block = "dimensions" +name = "nmawwells" +type = "integer" +reader = "urword" +optional = false +longname = "number of maw wells" +description = "integer value specifying the number of multi-aquifer wells that will be simulated for all stress periods." + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(nmawwells)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.radius] +block = "packagedata" +name = "radius" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.bottom] +block = "packagedata" +name = "bottom" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.strt] +block = "packagedata" +name = "strt" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.condeqn] +block = "packagedata" +name = "condeqn" +type = "string" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.ngwfnodes] +block = "packagedata" +name = "ngwfnodes" +type = "integer" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.aux] +block = "packagedata" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +time_series = "true" +optional = "true" +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." + +[packagedata.packagedata.item.fields.boundname] +block = "packagedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." + +[connectiondata.connectiondata] +block = "connectiondata" +name = "connectiondata" +type = "list" +reader = "urword" + +[connectiondata.connectiondata.item] +name = "connectiondata" +type = "record" +block = "connectiondata" +reader = "urword" + +[connectiondata.connectiondata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[connectiondata.connectiondata.item.fields.icon] +block = "connectiondata" +name = "icon" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[connectiondata.connectiondata.item.fields.cellid] +block = "connectiondata" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[connectiondata.connectiondata.item.fields.scrn_top] +block = "connectiondata" +name = "scrn_top" +type = "double precision" +reader = "urword" +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." + +[connectiondata.connectiondata.item.fields.scrn_bot] +block = "connectiondata" +name = "scrn_bot" +type = "double precision" +reader = "urword" +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." + +[connectiondata.connectiondata.item.fields.hk_skin] +block = "connectiondata" +name = "hk_skin" +type = "double precision" +reader = "urword" +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." + +[connectiondata.connectiondata.item.fields.radius_skin] +block = "connectiondata" +name = "radius_skin" +type = "double precision" +reader = "urword" +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." + +[period] +transient_block = true + +[period.perioddata] +block = "period" +name = "perioddata" +type = "list" +reader = "urword" + +[period.perioddata.item] +name = "perioddata" +type = "record" +block = "period" +reader = "urword" + +[period.perioddata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = true + +[period.perioddata.item.fields.mawsetting] +block = "period" +name = "mawsetting" +type = "union" +reader = "urword" +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, flowing_well, rate, well_head, head_limit, shut_off, rate_scaling, and auxiliary." + +[period.perioddata.item.fields.mawsetting.choices.status] +block = "period" +name = "status" +type = "string" +reader = "urword" +longname = "well status" +description = "keyword option to define well status. status can be active, inactive, or constant. by default, status is active." + +[period.perioddata.item.fields.mawsetting.choices.flowing_wellrecord] +block = "period" +name = "flowing_wellrecord" +type = "record" +reader = "urword" + +[period.perioddata.item.fields.mawsetting.choices.flowing_wellrecord.fields.flowing_well] +block = "period" +name = "flowing_well" +type = "keyword" +reader = "urword" +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." + +[period.perioddata.item.fields.mawsetting.choices.flowing_wellrecord.fields.fwelev] +block = "period" +name = "fwelev" +type = "double precision" +reader = "urword" +longname = "flowing well elevation" +description = "elevation used to determine whether or not the well is flowing." + +[period.perioddata.item.fields.mawsetting.choices.flowing_wellrecord.fields.fwcond] +block = "period" +name = "fwcond" +type = "double precision" +reader = "urword" +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)." + +[period.perioddata.item.fields.mawsetting.choices.flowing_wellrecord.fields.fwrlen] +block = "period" +name = "fwrlen" +type = "double precision" +reader = "urword" +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." + +[period.perioddata.item.fields.mawsetting.choices.rate] +block = "period" +name = "rate" +type = "double precision" +reader = "urword" +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 + +[period.perioddata.item.fields.mawsetting.choices.well_head] +block = "period" +name = "well_head" +type = "double precision" +reader = "urword" +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 + +[period.perioddata.item.fields.mawsetting.choices.head_limit] +block = "period" +name = "head_limit" +type = "string" +reader = "urword" +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'." + +[period.perioddata.item.fields.mawsetting.choices.shutoffrecord] +block = "period" +name = "shutoffrecord" +type = "record" +reader = "urword" + +[period.perioddata.item.fields.mawsetting.choices.shutoffrecord.fields.shut_off] +block = "period" +name = "shut_off" +type = "keyword" +reader = "urword" +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." + +[period.perioddata.item.fields.mawsetting.choices.shutoffrecord.fields.minrate] +block = "period" +name = "minrate" +type = "double precision" +reader = "urword" +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." + +[period.perioddata.item.fields.mawsetting.choices.shutoffrecord.fields.maxrate] +block = "period" +name = "maxrate" +type = "double precision" +reader = "urword" +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." + +[period.perioddata.item.fields.mawsetting.choices.rate_scalingrecord] +block = "period" +name = "rate_scalingrecord" +type = "record" +reader = "urword" + +[period.perioddata.item.fields.mawsetting.choices.rate_scalingrecord.fields.rate_scaling] +block = "period" +name = "rate_scaling" +type = "keyword" +reader = "urword" +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." + +[period.perioddata.item.fields.mawsetting.choices.rate_scalingrecord.fields.pump_elevation] +block = "period" +name = "pump_elevation" +type = "double precision" +reader = "urword" +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." + +[period.perioddata.item.fields.mawsetting.choices.rate_scalingrecord.fields.scaling_length] +block = "period" +name = "scaling_length" +type = "double precision" +reader = "urword" +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." + +[period.perioddata.item.fields.mawsetting.choices.auxiliaryrecord] +block = "period" +name = "auxiliaryrecord" +type = "record" +reader = "urword" + +[period.perioddata.item.fields.mawsetting.choices.auxiliaryrecord.fields.auxiliary] +block = "period" +name = "auxiliary" +type = "keyword" +reader = "urword" +description = "keyword for specifying auxiliary variable." + +[period.perioddata.item.fields.mawsetting.choices.auxiliaryrecord.fields.auxname] +block = "period" +name = "auxname" +type = "string" +reader = "urword" +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." + +[period.perioddata.item.fields.mawsetting.choices.auxiliaryrecord.fields.auxval] +block = "period" +name = "auxval" +type = "double precision" +reader = "urword" +time_series = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-mvr.toml b/flopy/mf6/data/dfn/toml/gwf-mvr.toml new file mode 100644 index 0000000000..55f9878447 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-mvr.toml @@ -0,0 +1,236 @@ +name = "gwf-mvr" +advanced = false +multi = false + +[ref] +parent = "parent_model_or_package" +key = "mvr_filerecord" +val = "perioddata" +abbr = "mvr" +param = "perioddata" + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.modelnames] +block = "options" +name = "modelnames" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[dimensions.maxmvr] +block = "dimensions" +name = "maxmvr" +type = "integer" +reader = "urword" +optional = false +longname = "maximum number of movers" +description = "integer value specifying the maximum number of water mover entries that will specified for any stress period." + +[dimensions.maxpackages] +block = "dimensions" +name = "maxpackages" +type = "integer" +reader = "urword" +optional = false +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." + +[packages.packages] +block = "packages" +name = "packages" +type = "list" +shape = "(npackages)" +reader = "urword" +optional = false + +[packages.packages.item] +name = "packages" +type = "record" +block = "packages" +reader = "urword" +optional = false + +[packages.packages.item.fields.mname] +block = "packages" +name = "mname" +type = "string" +reader = "urword" +optional = "true" +description = "name of model containing the package. Model names are assigned by the user in the simulation name file." + +[packages.packages.item.fields.pname] +block = "packages" +name = "pname" +type = "string" +reader = "urword" +optional = "false" +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." + +[period] +transient_block = true + +[period.perioddata] +block = "period" +name = "perioddata" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[period.perioddata.item] +name = "perioddata" +type = "record" +block = "period" +reader = "urword" + +[period.perioddata.item.fields.mname1] +block = "period" +name = "mname1" +type = "string" +reader = "urword" +optional = "true" +description = "name of model containing the package, PNAME1." + +[period.perioddata.item.fields.pname1] +block = "period" +name = "pname1" +type = "string" +reader = "urword" +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." + +[period.perioddata.item.fields.id1] +block = "period" +name = "id1" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[period.perioddata.item.fields.mname2] +block = "period" +name = "mname2" +type = "string" +reader = "urword" +optional = "true" +description = "name of model containing the package, PNAME2." + +[period.perioddata.item.fields.pname2] +block = "period" +name = "pname2" +type = "string" +reader = "urword" +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." + +[period.perioddata.item.fields.id2] +block = "period" +name = "id2" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[period.perioddata.item.fields.mvrtype] +block = "period" +name = "mvrtype" +type = "string" +reader = "urword" +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." + +[period.perioddata.item.fields.value] +block = "period" +name = "value" +type = "double precision" +reader = "urword" +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$." diff --git a/flopy/mf6/data/dfn/toml/gwf-nam.toml b/flopy/mf6/data/dfn/toml/gwf-nam.toml new file mode 100644 index 0000000000..f11b2ba7f6 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-nam.toml @@ -0,0 +1,221 @@ +name = "gwf-nam" +advanced = false +multi = false + +[options.list] +block = "options" +name = "list" +type = "string" +reader = "urword" +optional = true +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'." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.newtonoptions] +block = "options" +name = "newtonoptions" +type = "record" +reader = "urword" +optional = true +longname = "newton keyword and options" +description = "none" + +[options.newtonoptions.fields.newton] +block = "options" +name = "newton" +type = "keyword" +reader = "urword" +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." + +[options.newtonoptions.fields.under_relaxation] +block = "options" +name = "under_relaxation" +type = "keyword" +reader = "urword" +optional = "true" +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." + +[options.nc_mesh2d_filerecord] +block = "options" +name = "nc_mesh2d_filerecord" +type = "record" +reader = "urword" +optional = true +description = "netcdf layered mesh fileout record." +mf6internal = "ncmesh2drec" + +[options.nc_mesh2d_filerecord.fields.netcdf_mesh2d] +block = "options" +name = "netcdf_mesh2d" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to a layered mesh netcdf file." +extended = "true" + +[options.nc_mesh2d_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.nc_mesh2d_filerecord.fields.ncmesh2dfile] +block = "options" +name = "ncmesh2dfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the netcdf ugrid layered mesh output file." +extended = "true" + +[options.nc_structured_filerecord] +block = "options" +name = "nc_structured_filerecord" +type = "record" +reader = "urword" +optional = true +description = "netcdf structured fileout record." +mf6internal = "ncstructrec" + +[options.nc_structured_filerecord.fields.netcdf_structured] +block = "options" +name = "netcdf_structured" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to a structured netcdf file." +mf6internal = "netcdf_struct" +extended = "true" + +[options.nc_structured_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.nc_structured_filerecord.fields.ncstructfile] +block = "options" +name = "ncstructfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the netcdf structured output file." +extended = "true" + +[options.nc_filerecord] +block = "options" +name = "nc_filerecord" +type = "record" +reader = "urword" +optional = true +description = "netcdf filerecord" + +[options.nc_filerecord.fields.netcdf] +block = "options" +name = "netcdf" +type = "keyword" +reader = "urword" +optional = "false" +longname = "netcdf keyword" +description = "keyword to specify that record corresponds to a netcdf input file." +extended = "true" + +[options.nc_filerecord.fields.filein] +block = "options" +name = "filein" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an input filename is expected next." + +[options.nc_filerecord.fields.netcdf_filename] +block = "options" +name = "netcdf_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "netcdf input filename" +description = "defines a netcdf input file." +mf6internal = "netcdf_fname" +extended = "true" + +[packages.packages] +block = "packages" +name = "packages" +type = "list" +reader = "urword" +optional = false +longname = "package list" + +[packages.packages.item] +name = "packages" +type = "record" +block = "packages" +reader = "urword" +optional = false +longname = "package list" + +[packages.packages.item.fields.ftype] +block = "packages" +name = "ftype" +type = "string" +reader = "urword" +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." + +[packages.packages.item.fields.fname] +block = "packages" +name = "fname" +type = "string" +reader = "urword" +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." + +[packages.packages.item.fields.pname] +block = "packages" +name = "pname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-npf.toml b/flopy/mf6/data/dfn/toml/gwf-npf.toml new file mode 100644 index 0000000000..cf72a84431 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-npf.toml @@ -0,0 +1,353 @@ +name = "gwf-npf" +advanced = false +multi = false + +[fkeys.tvk_filerecord] +parent = "parent_package" +key = "tvk_filerecord" +val = "perioddata" +abbr = "tvk" +param = "tvk_perioddata" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "ipakcb" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.alternative_cell_averaging] +block = "options" +name = "alternative_cell_averaging" +type = "string" +reader = "urword" +optional = true +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." +valid = "logarithmic amt-lmk amt-hmk" +mf6internal = "cellavg" + +[options.thickstrt] +block = "options" +name = "thickstrt" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "ithickstrt" + +[options.cvoptions] +block = "options" +name = "cvoptions" +type = "record" +reader = "urword" +optional = true +longname = "vertical conductance options" +description = "none" + +[options.cvoptions.fields.variablecv] +block = "options" +name = "variablecv" +type = "keyword" +reader = "urword" +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." +mf6internal = "ivarcv" + +[options.cvoptions.fields.dewatered] +block = "options" +name = "dewatered" +type = "keyword" +reader = "urword" +optional = "true" +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." +mf6internal = "idewatcv" + +[options.perched] +block = "options" +name = "perched" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iperched" + +[options.rewet_record] +block = "options" +name = "rewet_record" +type = "record" +reader = "urword" +optional = true + +[options.rewet_record.fields.rewet] +block = "options" +name = "rewet" +type = "keyword" +reader = "urword" +optional = "false" +longname = "keyword to activate rewetting" +description = "activates model rewetting. Rewetting is off by default." +mf6internal = "irewet" + +[options.rewet_record.fields.wetfct] +block = "options" +name = "wetfct" +type = "double precision" +reader = "urword" +optional = "false" +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." + +[options.rewet_record.fields.iwetit] +block = "options" +name = "iwetit" +type = "integer" +reader = "urword" +optional = "false" +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." + +[options.rewet_record.fields.ihdwet] +block = "options" +name = "ihdwet" +type = "integer" +reader = "urword" +optional = "false" +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)." + +[options.xt3doptions] +block = "options" +name = "xt3doptions" +type = "record" +reader = "urword" +optional = true +longname = "keyword to activate xt3d" +description = "none" + +[options.xt3doptions.fields.xt3d] +block = "options" +name = "xt3d" +type = "keyword" +reader = "urword" +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." +mf6internal = "ixt3d" + +[options.xt3doptions.fields.rhs] +block = "options" +name = "rhs" +type = "keyword" +reader = "urword" +optional = "true" +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." +mf6internal = "ixt3drhs" + +[options.save_specific_discharge] +block = "options" +name = "save_specific_discharge" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "isavspdis" + +[options.save_saturation] +block = "options" +name = "save_saturation" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "isavsat" + +[options.k22overk] +block = "options" +name = "k22overk" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "ik22overk" + +[options.k33overk] +block = "options" +name = "k33overk" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "ik33overk" + +[options.perioddata] +block = "options" +name = "perioddata" +type = "record tvk6 filein tvk6_filename" +reader = "urword" +optional = true +description = "Contains data for the tvk package. Data can be passed as a dictionary to the tvk package with variable names as keys and package data as values. Data for the perioddata variable is also acceptable. See tvk package documentation for more information." + +[options.perioddata.ref] +parent = "parent_package" +key = "tvk_filerecord" +val = "perioddata" +abbr = "tvk" +param = "tvk_perioddata" + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[options.dev_no_newton] +block = "options" +name = "dev_no_newton" +type = "keyword" +reader = "urword" +optional = true +longname = "turn off newton for unconfined cells" +description = "turn off newton for unconfined cells" +mf6internal = "inewton" + +[options.dev_omega] +block = "options" +name = "dev_omega" +type = "double precision" +reader = "urword" +optional = true +longname = "set saturation omega value" +description = "set saturation omega value" +mf6internal = "satomega" + +[griddata.icelltype] +block = "griddata" +name = "icelltype" +type = "integer" +shape = "(nodes)" +default = 0 +reader = "readarray" +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." +layered = true +netcdf = true + +[griddata.k] +block = "griddata" +name = "k" +type = "double precision" +shape = "(nodes)" +default = 1.0 +reader = "readarray" +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." +layered = true +netcdf = true + +[griddata.k22] +block = "griddata" +name = "k22" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.k33] +block = "griddata" +name = "k33" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.angle1] +block = "griddata" +name = "angle1" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.angle2] +block = "griddata" +name = "angle2" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.angle3] +block = "griddata" +name = "angle3" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.wetdry] +block = "griddata" +name = "wetdry" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true diff --git a/flopy/mf6/data/dfn/toml/gwf-oc.toml b/flopy/mf6/data/dfn/toml/gwf-oc.toml new file mode 100644 index 0000000000..24fca1c32d --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-oc.toml @@ -0,0 +1,197 @@ +name = "gwf-oc" +advanced = false +multi = false + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.head_filerecord] +block = "options" +name = "head_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.head_filerecord.fields.head] +block = "options" +name = "head" +type = "keyword" +reader = "urword" +optional = "false" +longname = "head keyword" +description = "keyword to specify that record corresponds to head." + +[options.head_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.head_filerecord.fields.headfile] +block = "options" +name = "headfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the output file to write head information." + +[options.headprintrecord] +block = "options" +name = "headprintrecord" +type = "record" +reader = "urword" +optional = true + +[options.headprintrecord.fields.head] +block = "options" +name = "head" +type = "keyword" +reader = "urword" +optional = "false" +longname = "head keyword" +description = "keyword to specify that record corresponds to head." + +[options.headprintrecord.fields.print_format] +block = "options" +name = "print_format" +type = "keyword" +reader = "urword" +optional = "false" +longname = "keyword to indicate that a print format follows" +description = "keyword to specify format for printing to the listing file." + +[period] +transient_block = true + +[period.saverecord] +block = "period" +name = "saverecord" +type = "record" +reader = "urword" +optional = true + +[period.saverecord.fields.save] +block = "period" +name = "save" +type = "keyword" +reader = "urword" +optional = "false" +longname = "keyword to save" +description = "keyword to indicate that information will be saved this stress period." + +[period.saverecord.fields.rtype] +block = "period" +name = "rtype" +type = "string" +reader = "urword" +optional = "false" +longname = "record type" +description = "type of information to save or print. Can be BUDGET or HEAD." + +[period.saverecord.fields.ocsetting] +block = "period" +name = "ocsetting" +type = "keystring all first last frequency steps" +reader = "urword" +description = "specifies the steps for which the data will be saved." + +[period.printrecord] +block = "period" +name = "printrecord" +type = "record" +reader = "urword" +optional = true + +[period.printrecord.fields.print] +block = "period" +name = "print" +type = "keyword" +reader = "urword" +optional = "false" +longname = "keyword to save" +description = "keyword to indicate that information will be printed this stress period." + +[period.printrecord.fields.rtype] +block = "period" +name = "rtype" +type = "string" +reader = "urword" +optional = "false" +longname = "record type" +description = "type of information to save or print. Can be BUDGET or HEAD." + +[period.printrecord.fields.ocsetting] +block = "period" +name = "ocsetting" +type = "keystring all first last frequency steps" +reader = "urword" +description = "specifies the steps for which the data will be saved." diff --git a/flopy/mf6/data/dfn/toml/gwf-rch.toml b/flopy/mf6/data/dfn/toml/gwf-rch.toml new file mode 100644 index 0000000000..cfef41cac7 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-rch.toml @@ -0,0 +1,181 @@ +name = "gwf-rch" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.fixed_cell] +block = "options" +name = "fixed_cell" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.auxmultname] +block = "options" +name = "auxmultname" +type = "string" +reader = "urword" +optional = true +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of recharge." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of recharge cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprpak" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "ipakcb" + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[dimensions.maxbound] +block = "dimensions" +name = "maxbound" +type = "integer" +reader = "urword" +optional = false +longname = "maximum number of recharge cells" +description = "integer value specifying the maximum number of recharge cells cells that will be specified for use during any stress period." + +[period] +transient_block = true + +[period.stress_period_data] +block = "period" +name = "stress_period_data" +type = "list" +shape = "(maxbound)" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item] +name = "stress_period_data" +type = "record" +block = "period" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item.fields.cellid] +block = "period" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[period.stress_period_data.item.fields.recharge] +block = "period" +name = "recharge" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.aux] +block = "period" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +optional = "true" +time_series = "true" +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." +mf6internal = "auxvar" + +[period.stress_period_data.item.fields.boundname] +block = "period" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-rcha.toml b/flopy/mf6/data/dfn/toml/gwf-rcha.toml new file mode 100644 index 0000000000..e3c192567e --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-rcha.toml @@ -0,0 +1,163 @@ +name = "gwf-rcha" +advanced = false +multi = true + +[fkeys.tas_filerecord] +parent = "parent_package" +key = "tas_filerecord" +val = "timearrayseries" +abbr = "tas" +param = "tas_array" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.readasarrays] +block = "options" +name = "readasarrays" +type = "keyword" +default = true +reader = "urword" +optional = false +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." + +[options.fixed_cell] +block = "options" +name = "fixed_cell" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.auxmultname] +block = "options" +name = "auxmultname" +type = "string" +reader = "urword" +optional = true +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of recharge." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprpak" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +longname = "save chd 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." +mf6internal = "ipakcb" + +[options.timearrayseries] +block = "options" +name = "timearrayseries" +type = "record tas6 filein tas6_filename" +reader = "urword" +optional = true +description = "Contains data for the tas package. Data can be passed as a dictionary to the tas package with variable names as keys and package data as values. Data for the timearrayseries variable is also acceptable. See tas package documentation for more information." + +[options.timearrayseries.ref] +parent = "parent_package" +key = "tas_filerecord" +val = "timearrayseries" +abbr = "tas" +param = "tas_array" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[period] +transient_block = true + +[period.irch] +block = "period" +name = "irch" +type = "integer" +shape = "(ncol*nrow; ncpl)" +reader = "readarray" +optional = true +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." +numeric_index = true + +[period.recharge] +block = "period" +name = "recharge" +type = "double precision" +shape = "(ncol*nrow; ncpl)" +default = 0.001 +reader = "readarray" +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)." +time_series = true + +[period.aux] +block = "period" +name = "aux" +type = "double precision" +shape = "(ncol*nrow; ncpl)" +reader = "readarray" +optional = true +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 a value of zero is assigned. if the value specified here for the auxiliary variable is the same as auxmultname, then the recharge array will be multiplied by this array." +time_series = true +mf6internal = "auxvar" diff --git a/flopy/mf6/data/dfn/toml/gwf-riv.toml b/flopy/mf6/data/dfn/toml/gwf-riv.toml new file mode 100644 index 0000000000..7b3b83a5ac --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-riv.toml @@ -0,0 +1,198 @@ +name = "gwf-riv" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.auxmultname] +block = "options" +name = "auxmultname" +type = "string" +reader = "urword" +optional = true +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of riverbed conductance." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of river cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprpak" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +longname = "save chd 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." +mf6internal = "ipakcb" + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.mover] +block = "options" +name = "mover" +type = "keyword" +reader = "urword" +optional = true +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." + +[dimensions.maxbound] +block = "dimensions" +name = "maxbound" +type = "integer" +reader = "urword" +optional = false +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." + +[period] +transient_block = true + +[period.stress_period_data] +block = "period" +name = "stress_period_data" +type = "list" +shape = "(maxbound)" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item] +name = "stress_period_data" +type = "record" +block = "period" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item.fields.cellid] +block = "period" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[period.stress_period_data.item.fields.stage] +block = "period" +name = "stage" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.cond] +block = "period" +name = "cond" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.rbot] +block = "period" +name = "rbot" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.aux] +block = "period" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +optional = "true" +time_series = "true" +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." +mf6internal = "auxvar" + +[period.stress_period_data.item.fields.boundname] +block = "period" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +longname = "drain 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." diff --git a/flopy/mf6/data/dfn/toml/gwf-sfr.toml b/flopy/mf6/data/dfn/toml/gwf-sfr.toml new file mode 100644 index 0000000000..ee15ca843d --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-sfr.toml @@ -0,0 +1,841 @@ +name = "gwf-sfr" +advanced = true +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.storage] +block = "options" +name = "storage" +type = "keyword" +reader = "urword" +optional = true +longname = "activate reach storage" +description = "keyword that activates storage contributions to the stream-flow routing package continuity equation." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of stream reach cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_stage] +block = "options" +name = "print_stage" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.stage_filerecord] +block = "options" +name = "stage_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.stage_filerecord.fields.stage] +block = "period" +name = "stage" +type = "string" +reader = "urword" +time_series = "true" +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." + +[options.stage_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.stage_filerecord.fields.stagefile] +block = "options" +name = "stagefile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write stage information." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.package_convergence_filerecord] +block = "options" +name = "package_convergence_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.package_convergence_filerecord.fields.package_convergence] +block = "options" +name = "package_convergence" +type = "keyword" +reader = "urword" +optional = "false" +longname = "package_convergence keyword" +description = "keyword to specify that record corresponds to the package convergence comma spaced values file." + +[options.package_convergence_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.package_convergence_filerecord.fields.package_convergence_filename] +block = "options" +name = "package_convergence_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.mover] +block = "options" +name = "mover" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.maximum_picard_iterations] +block = "options" +name = "maximum_picard_iterations" +type = "integer" +reader = "urword" +optional = true +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." + +[options.maximum_iterations] +block = "options" +name = "maximum_iterations" +type = "integer" +reader = "urword" +optional = true +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." + +[options.maximum_depth_change] +block = "options" +name = "maximum_depth_change" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.unit_conversion] +block = "options" +name = "unit_conversion" +type = "double precision" +reader = "urword" +optional = true +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." +deprecated = "6.4.2" + +[options.length_conversion] +block = "options" +name = "length_conversion" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.time_conversion] +block = "options" +name = "time_conversion" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.dev_storage_weight] +block = "options" +name = "dev_storage_weight" +type = "double precision" +reader = "urword" +optional = true +longname = "reach storage time weighting" +description = "real number value that defines the time weighting factor used to calculate the change in channel storage. storage_weight must have a value between 0.5 and 1. default storage_weight value is 1." + +[dimensions.nreaches] +block = "dimensions" +name = "nreaches" +type = "integer" +reader = "urword" +optional = false +longname = "maximum number reaches" +description = "integer value specifying the number of stream reaches. there must be nreaches entries in the packagedata block." + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.cellid] +block = "packagedata" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.rlen] +block = "packagedata" +name = "rlen" +type = "double precision" +reader = "urword" +longname = "reach length" +description = "real value that defines the reach length. RLEN must be greater than zero." + +[packagedata.packagedata.item.fields.rwid] +block = "packagedata" +name = "rwid" +type = "double precision" +reader = "urword" +longname = "reach width" +description = "real value that defines the reach width. RWID must be greater than zero." + +[packagedata.packagedata.item.fields.rgrd] +block = "packagedata" +name = "rgrd" +type = "double precision" +reader = "urword" +longname = "stream gradient" +description = "real value that defines the stream gradient (slope) across the reach. RGRD must be greater than zero." + +[packagedata.packagedata.item.fields.rtp] +block = "packagedata" +name = "rtp" +type = "double precision" +reader = "urword" +longname = "reach bottom" +description = "real value that defines the bottom elevation of the reach." + +[packagedata.packagedata.item.fields.rbth] +block = "packagedata" +name = "rbth" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.rhk] +block = "packagedata" +name = "rhk" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[packagedata.packagedata.item.fields.man] +block = "packagedata" +name = "man" +type = "string" +reader = "urword" +time_series = "true" +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." + +[packagedata.packagedata.item.fields.ncon] +block = "packagedata" +name = "ncon" +type = "integer" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.ustrf] +block = "packagedata" +name = "ustrf" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[packagedata.packagedata.item.fields.ndv] +block = "packagedata" +name = "ndv" +type = "integer" +reader = "urword" +longname = "number of downstream reaches" +description = "integer value that defines the number of downstream diversions for the reach." + +[packagedata.packagedata.item.fields.aux] +block = "packagedata" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +time_series = "true" +optional = "true" +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." + +[packagedata.packagedata.item.fields.boundname] +block = "packagedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." + +[crosssections.crosssections] +block = "crosssections" +name = "crosssections" +type = "list" +reader = "urword" +optional = false + +[crosssections.crosssections.item] +name = "crosssections" +type = "record" +block = "crosssections" +optional = false +reader = "urword" + +[crosssections.crosssections.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[crosssections.crosssections.item.fields.tab6] +block = "period" +name = "tab6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "head keyword" +description = "keyword to specify that record corresponds to a cross-section table file." + +[crosssections.crosssections.item.fields.filein] +block = "period" +name = "filein" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an input filename is expected next." + +[crosssections.crosssections.item.fields.tab6_filename] +block = "period" +name = "tab6_filename" +type = "string" +reader = "urword" +optional = "false" +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." + +[connectiondata.connectiondata] +block = "connectiondata" +name = "connectiondata" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[connectiondata.connectiondata.item] +name = "connectiondata" +type = "record" +block = "connectiondata" +reader = "urword" + +[connectiondata.connectiondata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[connectiondata.connectiondata.item.fields.ic] +block = "connectiondata" +name = "ic" +type = "integer" +shape = "(ncon(ifno))" +reader = "urword" +optional = "true" +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." +numeric_index = "true" +support_negative_index = "true" + +[diversions.diversions] +block = "diversions" +name = "diversions" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[diversions.diversions.item] +name = "diversions" +type = "record" +block = "diversions" +reader = "urword" + +[diversions.diversions.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[diversions.diversions.item.fields.idv] +block = "period" +name = "idv" +type = "integer" +reader = "urword" +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)." +numeric_index = "true" + +[diversions.diversions.item.fields.iconr] +block = "diversions" +name = "iconr" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[diversions.diversions.item.fields.cprior] +block = "diversions" +name = "cprior" +type = "string" +reader = "urword" +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." + +[initialstages.initialstages] +block = "initialstages" +name = "initialstages" +type = "list" +shape = "(maxbound)" +reader = "urword" +optional = false + +[initialstages.initialstages.item] +name = "initialstages" +type = "record" +block = "initialstages" +optional = false +reader = "urword" + +[initialstages.initialstages.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[initialstages.initialstages.item.fields.initialstage] +block = "initialstages" +name = "initialstage" +type = "double precision" +optional = "false" +reader = "urword" +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." + +[period] +transient_block = true + +[period.perioddata] +block = "period" +name = "perioddata" +type = "list" +reader = "urword" + +[period.perioddata.item] +name = "perioddata" +type = "record" +block = "period" +reader = "urword" + +[period.perioddata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = true + +[period.perioddata.item.fields.sfrsetting] +block = "period" +name = "sfrsetting" +type = "union" +reader = "urword" +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." + +[period.perioddata.item.fields.sfrsetting.choices.stage] +block = "period" +name = "stage" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.sfrsetting.choices.status] +block = "period" +name = "status" +type = "string" +reader = "urword" +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." + +[period.perioddata.item.fields.sfrsetting.choices.bedk] +block = "period" +name = "bedk" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.sfrsetting.choices.manning] +block = "period" +name = "manning" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.sfrsetting.choices.inflow] +block = "period" +name = "inflow" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.sfrsetting.choices.rainfall] +block = "period" +name = "rainfall" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.sfrsetting.choices.evaporation] +block = "period" +name = "evaporation" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.sfrsetting.choices.runoff] +block = "period" +name = "runoff" +type = "string" +reader = "urword" +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 + +[period.perioddata.item.fields.sfrsetting.choices.diversionrecord] +block = "period" +name = "diversionrecord" +type = "record" +reader = "urword" + +[period.perioddata.item.fields.sfrsetting.choices.diversionrecord.fields.diversion] +block = "period" +name = "diversion" +type = "keyword" +reader = "urword" +longname = "diversion keyword" +description = "keyword to indicate diversion record." + +[period.perioddata.item.fields.sfrsetting.choices.diversionrecord.fields.idv] +block = "period" +name = "idv" +type = "integer" +reader = "urword" +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)." +numeric_index = "true" + +[period.perioddata.item.fields.sfrsetting.choices.diversionrecord.fields.divflow] +block = "period" +name = "divflow" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.perioddata.item.fields.sfrsetting.choices.upstream_fraction] +block = "period" +name = "upstream_fraction" +type = "double precision" +reader = "urword" +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." + +[period.perioddata.item.fields.sfrsetting.choices.cross_sectionrecord] +block = "period" +name = "cross_sectionrecord" +type = "record" +reader = "urword" + +[period.perioddata.item.fields.sfrsetting.choices.cross_sectionrecord.fields.cross_section] +block = "period" +name = "cross_section" +type = "keyword" +reader = "urword" +optional = "false" +longname = "cross_section keyword" +description = "keyword to specify that record corresponds to a reach cross-section." + +[period.perioddata.item.fields.sfrsetting.choices.cross_sectionrecord.fields.tab6] +block = "period" +name = "tab6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "head keyword" +description = "keyword to specify that record corresponds to a cross-section table file." + +[period.perioddata.item.fields.sfrsetting.choices.cross_sectionrecord.fields.filein] +block = "period" +name = "filein" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an input filename is expected next." + +[period.perioddata.item.fields.sfrsetting.choices.cross_sectionrecord.fields.tab6_filename] +block = "period" +name = "tab6_filename" +type = "string" +reader = "urword" +optional = "false" +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." + +[period.perioddata.item.fields.sfrsetting.choices.auxiliaryrecord] +block = "period" +name = "auxiliaryrecord" +type = "record" +reader = "urword" + +[period.perioddata.item.fields.sfrsetting.choices.auxiliaryrecord.fields.auxiliary] +block = "period" +name = "auxiliary" +type = "keyword" +reader = "urword" +description = "keyword for specifying auxiliary variable." + +[period.perioddata.item.fields.sfrsetting.choices.auxiliaryrecord.fields.auxname] +block = "period" +name = "auxname" +type = "string" +reader = "urword" +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." + +[period.perioddata.item.fields.sfrsetting.choices.auxiliaryrecord.fields.auxval] +block = "period" +name = "auxval" +type = "double precision" +reader = "urword" +time_series = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-sto.toml b/flopy/mf6/data/dfn/toml/gwf-sto.toml new file mode 100644 index 0000000000..cb2d4e6344 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-sto.toml @@ -0,0 +1,156 @@ +name = "gwf-sto" +advanced = false +multi = false + +[fkeys.tvs_filerecord] +parent = "parent_package" +key = "tvs_filerecord" +val = "perioddata" +abbr = "tvs" +param = "tvs_perioddata" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "ipakcb" + +[options.storagecoefficient] +block = "options" +name = "storagecoefficient" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "istor_coef" + +[options.ss_confined_only] +block = "options" +name = "ss_confined_only" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.perioddata] +block = "options" +name = "perioddata" +type = "record tvs6 filein tvs6_filename" +reader = "urword" +optional = true +description = "Contains data for the tvs package. Data can be passed as a dictionary to the tvs package with variable names as keys and package data as values. Data for the perioddata variable is also acceptable. See tvs package documentation for more information." + +[options.perioddata.ref] +parent = "parent_package" +key = "tvs_filerecord" +val = "perioddata" +abbr = "tvs" +param = "tvs_perioddata" + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[options.dev_original_specific_storage] +block = "options" +name = "dev_original_specific_storage" +type = "keyword" +reader = "urword" +optional = true +longname = "development option for original specific storage" +description = "flag indicating the original storage specific storage formulation should be used" +mf6internal = "iorig_ss" + +[options.dev_oldstorageformulation] +block = "options" +name = "dev_oldstorageformulation" +type = "keyword" +reader = "urword" +optional = true +longname = "development option flag for old storage formulation" +description = "development option flag for old storage formulation" +mf6internal = "iconf_ss" + +[griddata.iconvert] +block = "griddata" +name = "iconvert" +type = "integer" +shape = "(nodes)" +default = 0 +reader = "readarray" +optional = false +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." +layered = true +netcdf = true + +[griddata.ss] +block = "griddata" +name = "ss" +type = "double precision" +shape = "(nodes)" +default = 1e-05 +reader = "readarray" +optional = false +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." +layered = true +netcdf = true + +[griddata.sy] +block = "griddata" +name = "sy" +type = "double precision" +shape = "(nodes)" +default = 0.15 +reader = "readarray" +optional = false +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)." +layered = true +netcdf = true + +[period] +transient_block = true + +[period.steady-state] +block = "period" +name = "steady-state" +type = "keyword" +reader = "urword" +optional = true +longname = "steady state indicator" +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." +mf6internal = "steady_state" + +[period.transient] +block = "period" +name = "transient" +type = "keyword" +reader = "urword" +optional = true +longname = "transient indicator" +description = "keyword to indicate that stress period iper is transient. transient conditions will apply until the steady-state keyword is specified in a subsequent begin period block." diff --git a/flopy/mf6/data/dfn/toml/gwf-uzf.toml b/flopy/mf6/data/dfn/toml/gwf-uzf.toml new file mode 100644 index 0000000000..c2b3e0e53b --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-uzf.toml @@ -0,0 +1,533 @@ +name = "gwf-uzf" +advanced = true +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.auxmultname] +block = "options" +name = "auxmultname" +type = "string" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of uzf cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.wc_filerecord] +block = "options" +name = "wc_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.wc_filerecord.fields.water_content] +block = "options" +name = "water_content" +type = "keyword" +reader = "urword" +optional = "false" +longname = "water_content keyword" +description = "keyword to specify that record corresponds to unsaturated zone water contents." + +[options.wc_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.wc_filerecord.fields.wcfile] +block = "options" +name = "wcfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write water content information." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.package_convergence_filerecord] +block = "options" +name = "package_convergence_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.package_convergence_filerecord.fields.package_convergence] +block = "options" +name = "package_convergence" +type = "keyword" +reader = "urword" +optional = "false" +longname = "package_convergence keyword" +description = "keyword to specify that record corresponds to the package convergence comma spaced values file." + +[options.package_convergence_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.package_convergence_filerecord.fields.package_convergence_filename] +block = "options" +name = "package_convergence_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the comma spaced values output file to write package convergence information." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.mover] +block = "options" +name = "mover" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.simulate_et] +block = "options" +name = "simulate_et" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.linear_gwet] +block = "options" +name = "linear_gwet" +type = "keyword" +reader = "urword" +optional = true +longname = "use linear evapotranspiration" +description = "keyword specifying that groundwater et will be simulated using the original et formulation of modflow-2005." + +[options.square_gwet] +block = "options" +name = "square_gwet" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.simulate_gwseep] +block = "options" +name = "simulate_gwseep" +type = "keyword" +reader = "urword" +optional = true +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." +deprecated = "6.5.0" + +[options.unsat_etwc] +block = "options" +name = "unsat_etwc" +type = "keyword" +reader = "urword" +optional = true +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)." + +[options.unsat_etae] +block = "options" +name = "unsat_etae" +type = "keyword" +reader = "urword" +optional = true +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." + +[dimensions.nuzfcells] +block = "dimensions" +name = "nuzfcells" +type = "integer" +reader = "urword" +optional = false +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." + +[dimensions.ntrailwaves] +block = "dimensions" +name = "ntrailwaves" +type = "integer" +default = 7 +reader = "urword" +optional = false +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." + +[dimensions.nwavesets] +block = "dimensions" +name = "nwavesets" +type = "integer" +default = 40 +reader = "urword" +optional = false +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." + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(nuzfcells)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +longname = "UZF id number" +description = "integer value that defines the feature (UZF object) number associated with the specified PERIOD data on the line." +numeric_index = "true" + +[packagedata.packagedata.item.fields.cellid] +block = "packagedata" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.landflag] +block = "packagedata" +name = "landflag" +type = "integer" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.ivertcon] +block = "packagedata" +name = "ivertcon" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.surfdep] +block = "packagedata" +name = "surfdep" +type = "double precision" +reader = "urword" +longname = "surface depression depth" +description = "is the surface depression depth of the UZF cell." + +[packagedata.packagedata.item.fields.vks] +block = "packagedata" +name = "vks" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.thtr] +block = "packagedata" +name = "thtr" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.thts] +block = "packagedata" +name = "thts" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.thti] +block = "packagedata" +name = "thti" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.eps] +block = "packagedata" +name = "eps" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.boundname] +block = "packagedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." + +[period] +transient_block = true + +[period.perioddata] +block = "period" +name = "perioddata" +type = "list" +reader = "urword" + +[period.perioddata.item] +name = "perioddata" +type = "record" +block = "period" +reader = "urword" + +[period.perioddata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +longname = "UZF id number" +description = "integer value that defines the feature (UZF object) number associated with the specified PERIOD data on the line." +numeric_index = "true" + +[period.perioddata.item.fields.finf] +block = "period" +name = "finf" +type = "string" +time_series = "true" +reader = "urword" +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." + +[period.perioddata.item.fields.pet] +block = "period" +name = "pet" +type = "string" +reader = "urword" +time_series = "true" +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." + +[period.perioddata.item.fields.extdp] +block = "period" +name = "extdp" +type = "string" +reader = "urword" +time_series = "true" +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." + +[period.perioddata.item.fields.extwc] +block = "period" +name = "extwc" +type = "string" +reader = "urword" +time_series = "true" +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." + +[period.perioddata.item.fields.ha] +block = "period" +name = "ha" +type = "string" +time_series = "true" +reader = "urword" +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." + +[period.perioddata.item.fields.hroot] +block = "period" +name = "hroot" +type = "string" +reader = "urword" +time_series = "true" +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." + +[period.perioddata.item.fields.rootact] +block = "period" +name = "rootact" +type = "string" +reader = "urword" +time_series = "true" +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." + +[period.perioddata.item.fields.aux] +block = "period" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +time_series = "true" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-vsc.toml b/flopy/mf6/data/dfn/toml/gwf-vsc.toml new file mode 100644 index 0000000000..50b209329c --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-vsc.toml @@ -0,0 +1,159 @@ +name = "gwf-vsc" +advanced = false +multi = false + +[options.viscref] +block = "options" +name = "viscref" +type = "double precision" +default = 1.0 +reader = "urword" +optional = true +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." + +[options.temperature_species_name] +block = "options" +name = "temperature_species_name" +type = "string" +reader = "urword" +optional = true +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." + +[options.thermal_formulation] +block = "options" +name = "thermal_formulation" +type = "string" +reader = "urword" +optional = true +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." +valid = "linear nonlinear" + +[options.thermal_a2] +block = "options" +name = "thermal_a2" +type = "double precision" +default = 10.0 +reader = "urword" +optional = true +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)." + +[options.thermal_a3] +block = "options" +name = "thermal_a3" +type = "double precision" +default = 248.37 +reader = "urword" +optional = true +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)." + +[options.thermal_a4] +block = "options" +name = "thermal_a4" +type = "double precision" +default = 133.15 +reader = "urword" +optional = true +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)." + +[options.viscosity_filerecord] +block = "options" +name = "viscosity_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.viscosity_filerecord.fields.viscosity] +block = "options" +name = "viscosity" +type = "keyword" +reader = "urword" +optional = "false" +longname = "viscosity keyword" +description = "keyword to specify that record corresponds to viscosity." + +[options.viscosity_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.viscosity_filerecord.fields.viscosityfile] +block = "options" +name = "viscosityfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[dimensions.nviscspecies] +block = "dimensions" +name = "nviscspecies" +type = "integer" +reader = "urword" +optional = false +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 then nrhospecies needs to be at least one." + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(nrhospecies)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.iviscspec] +block = "packagedata" +name = "iviscspec" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.dviscdc] +block = "packagedata" +name = "dviscdc" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.cviscref] +block = "packagedata" +name = "cviscref" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.modelname] +block = "packagedata" +name = "modelname" +type = "string" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.auxspeciesname] +block = "packagedata" +name = "auxspeciesname" +type = "string" +reader = "urword" +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." diff --git a/flopy/mf6/data/dfn/toml/gwf-wel.toml b/flopy/mf6/data/dfn/toml/gwf-wel.toml new file mode 100644 index 0000000000..026592cd90 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwf-wel.toml @@ -0,0 +1,226 @@ +name = "gwf-wel" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.auxmultname] +block = "options" +name = "auxmultname" +type = "string" +reader = "urword" +optional = true +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of well flow rate." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of well cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprpak" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "ipakcb" + +[options.auto_flow_reduce] +block = "options" +name = "auto_flow_reduce" +type = "double precision" +reader = "urword" +optional = true +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)." +mf6internal = "flowred" + +[options.afrcsv_filerecord] +block = "options" +name = "afrcsv_filerecord" +type = "record" +reader = "urword" +optional = true +mf6internal = "afrcsv_rec" + +[options.afrcsv_filerecord.fields.auto_flow_reduce_csv] +block = "options" +name = "auto_flow_reduce_csv" +type = "keyword" +reader = "urword" +optional = "false" +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." +mf6internal = "afrcsv" + +[options.afrcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.afrcsv_filerecord.fields.afrcsvfile] +block = "options" +name = "afrcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.mover] +block = "options" +name = "mover" +type = "keyword" +reader = "urword" +optional = true +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." + +[dimensions.maxbound] +block = "dimensions" +name = "maxbound" +type = "integer" +reader = "urword" +optional = false +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." + +[period] +transient_block = true + +[period.stress_period_data] +block = "period" +name = "stress_period_data" +type = "list" +shape = "(maxbound)" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item] +name = "stress_period_data" +type = "record" +block = "period" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item.fields.cellid] +block = "period" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[period.stress_period_data.item.fields.q] +block = "period" +name = "q" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.aux] +block = "period" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +optional = "true" +time_series = "true" +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." +mf6internal = "auxvar" + +[period.stress_period_data.item.fields.boundname] +block = "period" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwt-adv.toml b/flopy/mf6/data/dfn/toml/gwt-adv.toml new file mode 100644 index 0000000000..d4db303872 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-adv.toml @@ -0,0 +1,22 @@ +name = "gwt-adv" +advanced = false +multi = false + +[options.scheme] +block = "options" +name = "scheme" +type = "string" +reader = "urword" +optional = true +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." +valid = "central upstream tvd" + +[options.ats_percel] +block = "options" +name = "ats_percel" +type = "double precision" +reader = "urword" +optional = true +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." diff --git a/flopy/mf6/data/dfn/toml/gwt-api.toml b/flopy/mf6/data/dfn/toml/gwt-api.toml new file mode 100644 index 0000000000..53ebca9341 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-api.toml @@ -0,0 +1,77 @@ +name = "gwt-api" +advanced = false +multi = false + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of api boundary cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.mover] +block = "options" +name = "mover" +type = "keyword" +reader = "urword" +optional = true +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." + +[dimensions.maxbound] +block = "dimensions" +name = "maxbound" +type = "integer" +reader = "urword" +optional = false +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." diff --git a/flopy/mf6/data/dfn/toml/gwt-cnc.toml b/flopy/mf6/data/dfn/toml/gwt-cnc.toml new file mode 100644 index 0000000000..d47a7ff03f --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-cnc.toml @@ -0,0 +1,173 @@ +name = "gwt-cnc" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.auxmultname] +block = "options" +name = "auxmultname" +type = "string" +reader = "urword" +optional = true +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of concentration value." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of constant concentration cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprflow" + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "ipakcb" + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." +mf6internal = "iprpak" + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[dimensions.maxbound] +block = "dimensions" +name = "maxbound" +type = "integer" +reader = "urword" +optional = false +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." + +[period] +transient_block = true + +[period.stress_period_data] +block = "period" +name = "stress_period_data" +type = "list" +shape = "(maxbound)" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item] +name = "stress_period_data" +type = "record" +block = "period" +reader = "urword" +mf6internal = "spd" + +[period.stress_period_data.item.fields.cellid] +block = "period" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[period.stress_period_data.item.fields.conc] +block = "period" +name = "conc" +type = "double precision" +reader = "urword" +time_series = "true" +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." +mf6internal = "tspvar" + +[period.stress_period_data.item.fields.aux] +block = "period" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +optional = "true" +time_series = "true" +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." +mf6internal = "auxvar" + +[period.stress_period_data.item.fields.boundname] +block = "period" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwt-dis.toml b/flopy/mf6/data/dfn/toml/gwt-dis.toml new file mode 100644 index 0000000000..8ec42e5ba3 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-dis.toml @@ -0,0 +1,214 @@ +name = "gwt-dis" +advanced = false +multi = false + +[fkeys.ncf_filerecord] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[options.length_units] +block = "options" +name = "length_units" +type = "string" +reader = "urword" +optional = true +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'." + +[options.nogrb] +block = "options" +name = "nogrb" +type = "keyword" +reader = "urword" +optional = true +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." + +[options.grb_filerecord] +block = "options" +name = "grb_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.grb_filerecord.fields.grb6] +block = "options" +name = "grb6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." +extended = "true" + +[options.grb_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.grb_filerecord.fields.grb6_filename] +block = "options" +name = "grb6_filename" +type = "string" +reader = "urword" +optional = "false" +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'." +extended = "true" + +[options.xorigin] +block = "options" +name = "xorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.yorigin] +block = "options" +name = "yorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.angrot] +block = "options" +name = "angrot" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[options.packagedata] +block = "options" +name = "packagedata" +type = "record ncf6 filein ncf6_filename" +reader = "urword" +optional = true +description = "Contains data for the ncf package. Data can be passed as a dictionary to the ncf package with variable names as keys and package data as values. Data for the packagedata variable is also acceptable. See ncf package documentation for more information." + +[options.packagedata.ref] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[dimensions.nlay] +block = "dimensions" +name = "nlay" +type = "integer" +default = 1 +reader = "urword" +optional = false +longname = "number of layers" +description = "is the number of layers in the model grid." + +[dimensions.nrow] +block = "dimensions" +name = "nrow" +type = "integer" +default = 2 +reader = "urword" +optional = false +longname = "number of rows" +description = "is the number of rows in the model grid." + +[dimensions.ncol] +block = "dimensions" +name = "ncol" +type = "integer" +default = 2 +reader = "urword" +optional = false +longname = "number of columns" +description = "is the number of columns in the model grid." + +[griddata.delr] +block = "griddata" +name = "delr" +type = "double precision" +shape = "(ncol)" +default = 1.0 +reader = "readarray" +longname = "spacing along a row" +description = "is the column spacing in the row direction." +netcdf = true + +[griddata.delc] +block = "griddata" +name = "delc" +type = "double precision" +shape = "(nrow)" +default = 1.0 +reader = "readarray" +longname = "spacing along a column" +description = "is the row spacing in the column direction." +netcdf = true + +[griddata.top] +block = "griddata" +name = "top" +type = "double precision" +shape = "(ncol, nrow)" +default = 1.0 +reader = "readarray" +longname = "cell top elevation" +description = "is the top elevation for each cell in the top model layer." +netcdf = true + +[griddata.botm] +block = "griddata" +name = "botm" +type = "double precision" +shape = "(ncol, nrow, nlay)" +default = 0.0 +reader = "readarray" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." +netcdf = true +layered = true + +[griddata.idomain] +block = "griddata" +name = "idomain" +type = "integer" +shape = "(ncol, nrow, nlay)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true diff --git a/flopy/mf6/data/dfn/toml/gwt-disu.toml b/flopy/mf6/data/dfn/toml/gwt-disu.toml new file mode 100644 index 0000000000..e3b2706dc1 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-disu.toml @@ -0,0 +1,341 @@ +name = "gwt-disu" +advanced = false +multi = false + +[options.length_units] +block = "options" +name = "length_units" +type = "string" +reader = "urword" +optional = true +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'." + +[options.nogrb] +block = "options" +name = "nogrb" +type = "keyword" +reader = "urword" +optional = true +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." + +[options.grb_filerecord] +block = "options" +name = "grb_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.grb_filerecord.fields.grb6] +block = "options" +name = "grb6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." +extended = "true" + +[options.grb_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.grb_filerecord.fields.grb6_filename] +block = "options" +name = "grb6_filename" +type = "string" +reader = "urword" +optional = "false" +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'." +extended = "true" + +[options.xorigin] +block = "options" +name = "xorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.yorigin] +block = "options" +name = "yorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.angrot] +block = "options" +name = "angrot" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.vertical_offset_tolerance] +block = "options" +name = "vertical_offset_tolerance" +type = "double precision" +default = 0.0 +reader = "urword" +optional = true +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." +mf6internal = "voffsettol" + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[dimensions.nodes] +block = "dimensions" +name = "nodes" +type = "integer" +reader = "urword" +optional = false +longname = "number of layers" +description = "is the number of cells in the model grid." + +[dimensions.nja] +block = "dimensions" +name = "nja" +type = "integer" +reader = "urword" +optional = false +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." + +[dimensions.nvert] +block = "dimensions" +name = "nvert" +type = "integer" +reader = "urword" +optional = true +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." + +[griddata.top] +block = "griddata" +name = "top" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +longname = "cell top elevation" +description = "is the top elevation for each cell in the model grid." + +[griddata.bot] +block = "griddata" +name = "bot" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." + +[griddata.area] +block = "griddata" +name = "area" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +longname = "cell surface area" +description = "is the cell surface area (in plan view)." + +[griddata.idomain] +block = "griddata" +name = "idomain" +type = "integer" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = false + +[connectiondata.iac] +block = "connectiondata" +name = "iac" +type = "integer" +shape = "(nodes)" +reader = "readarray" +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." + +[connectiondata.ja] +block = "connectiondata" +name = "ja" +type = "integer" +shape = "(nja)" +reader = "readarray" +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." +numeric_index = true +jagged_array = "iac" + +[connectiondata.ihc] +block = "connectiondata" +name = "ihc" +type = "integer" +shape = "(nja)" +reader = "readarray" +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." +jagged_array = "iac" + +[connectiondata.cl12] +block = "connectiondata" +name = "cl12" +type = "double precision" +shape = "(nja)" +reader = "readarray" +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." +jagged_array = "iac" + +[connectiondata.hwva] +block = "connectiondata" +name = "hwva" +type = "double precision" +shape = "(nja)" +reader = "readarray" +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." +jagged_array = "iac" + +[connectiondata.angldegx] +block = "connectiondata" +name = "angldegx" +type = "double precision" +shape = "(nja)" +reader = "readarray" +optional = true +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." +jagged_array = "iac" + +[vertices.vertices] +block = "vertices" +name = "vertices" +type = "list" +shape = "(nvert)" +reader = "urword" +optional = true +longname = "vertices data" + +[vertices.vertices.item] +name = "vertices" +type = "record" +block = "vertices" +reader = "urword" +optional = true +longname = "vertices data" + +[vertices.vertices.item.fields.iv] +block = "vertices" +name = "iv" +type = "integer" +reader = "urword" +optional = "false" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +numeric_index = "true" + +[vertices.vertices.item.fields.xv] +block = "vertices" +name = "xv" +type = "double precision" +reader = "urword" +optional = "false" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." + +[vertices.vertices.item.fields.yv] +block = "vertices" +name = "yv" +type = "double precision" +reader = "urword" +optional = "false" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." + +[cell2d.cell2d] +block = "cell2d" +name = "cell2d" +type = "list" +shape = "(nodes)" +reader = "urword" +optional = true +longname = "cell2d data" + +[cell2d.cell2d.item] +name = "cell2d" +type = "record" +block = "cell2d" +reader = "urword" +optional = true +longname = "cell2d data" + +[cell2d.cell2d.item.fields.icell2d] +block = "cell2d" +name = "icell2d" +type = "integer" +reader = "urword" +optional = "false" +longname = "cell2d number" +description = "is the cell2d number. Records in the CELL2D block must be listed in consecutive order from 1 to NODES." +numeric_index = "true" + +[cell2d.cell2d.item.fields.xc] +block = "cell2d" +name = "xc" +type = "double precision" +reader = "urword" +optional = "false" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." + +[cell2d.cell2d.item.fields.yc] +block = "cell2d" +name = "yc" +type = "double precision" +reader = "urword" +optional = "false" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." + +[cell2d.cell2d.item.fields.ncvert] +block = "cell2d" +name = "ncvert" +type = "integer" +reader = "urword" +optional = "false" +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." + +[cell2d.cell2d.item.fields.icvert] +block = "cell2d" +name = "icvert" +type = "integer" +shape = "(ncvert)" +reader = "urword" +optional = "false" +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." +numeric_index = "true" diff --git a/flopy/mf6/data/dfn/toml/gwt-disv.toml b/flopy/mf6/data/dfn/toml/gwt-disv.toml new file mode 100644 index 0000000000..89b77c6bd6 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-disv.toml @@ -0,0 +1,297 @@ +name = "gwt-disv" +advanced = false +multi = false + +[fkeys.ncf_filerecord] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[options.length_units] +block = "options" +name = "length_units" +type = "string" +reader = "urword" +optional = true +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'." + +[options.nogrb] +block = "options" +name = "nogrb" +type = "keyword" +reader = "urword" +optional = true +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." + +[options.grb_filerecord] +block = "options" +name = "grb_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.grb_filerecord.fields.grb6] +block = "options" +name = "grb6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." +extended = "true" + +[options.grb_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.grb_filerecord.fields.grb6_filename] +block = "options" +name = "grb6_filename" +type = "string" +reader = "urword" +optional = "false" +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'." +extended = "true" + +[options.xorigin] +block = "options" +name = "xorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.yorigin] +block = "options" +name = "yorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.angrot] +block = "options" +name = "angrot" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[options.packagedata] +block = "options" +name = "packagedata" +type = "record ncf6 filein ncf6_filename" +reader = "urword" +optional = true +description = "Contains data for the ncf package. Data can be passed as a dictionary to the ncf package with variable names as keys and package data as values. Data for the packagedata variable is also acceptable. See ncf package documentation for more information." + +[options.packagedata.ref] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[dimensions.nlay] +block = "dimensions" +name = "nlay" +type = "integer" +reader = "urword" +optional = false +longname = "number of layers" +description = "is the number of layers in the model grid." + +[dimensions.ncpl] +block = "dimensions" +name = "ncpl" +type = "integer" +reader = "urword" +optional = false +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." + +[dimensions.nvert] +block = "dimensions" +name = "nvert" +type = "integer" +reader = "urword" +optional = false +longname = "number of columns" +description = "is the total number of (x, y) vertex pairs used to characterize the horizontal configuration of the model grid." + +[griddata.top] +block = "griddata" +name = "top" +type = "double precision" +shape = "(ncpl)" +reader = "readarray" +longname = "model top elevation" +description = "is the top elevation for each cell in the top model layer." +netcdf = true + +[griddata.botm] +block = "griddata" +name = "botm" +type = "double precision" +shape = "(ncpl, nlay)" +reader = "readarray" +longname = "model bottom elevation" +description = "is the bottom elevation for each cell." +layered = true +netcdf = true + +[griddata.idomain] +block = "griddata" +name = "idomain" +type = "integer" +shape = "(ncpl, nlay)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[vertices.vertices] +block = "vertices" +name = "vertices" +type = "list" +shape = "(nvert)" +reader = "urword" +optional = false +longname = "vertices data" + +[vertices.vertices.item] +name = "vertices" +type = "record" +block = "vertices" +reader = "urword" +optional = false +longname = "vertices data" + +[vertices.vertices.item.fields.iv] +block = "vertices" +name = "iv" +type = "integer" +reader = "urword" +optional = "false" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +numeric_index = "true" + +[vertices.vertices.item.fields.xv] +block = "vertices" +name = "xv" +type = "double precision" +reader = "urword" +optional = "false" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." + +[vertices.vertices.item.fields.yv] +block = "vertices" +name = "yv" +type = "double precision" +reader = "urword" +optional = "false" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." + +[cell2d.cell2d] +block = "cell2d" +name = "cell2d" +type = "list" +shape = "(ncpl)" +reader = "urword" +optional = false +longname = "cell2d data" + +[cell2d.cell2d.item] +name = "cell2d" +type = "record" +block = "cell2d" +reader = "urword" +optional = false +longname = "cell2d data" + +[cell2d.cell2d.item.fields.icell2d] +block = "cell2d" +name = "icell2d" +type = "integer" +reader = "urword" +optional = "false" +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." +numeric_index = "true" + +[cell2d.cell2d.item.fields.xc] +block = "cell2d" +name = "xc" +type = "double precision" +reader = "urword" +optional = "false" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." + +[cell2d.cell2d.item.fields.yc] +block = "cell2d" +name = "yc" +type = "double precision" +reader = "urword" +optional = "false" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." + +[cell2d.cell2d.item.fields.ncvert] +block = "cell2d" +name = "ncvert" +type = "integer" +reader = "urword" +optional = "false" +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." + +[cell2d.cell2d.item.fields.icvert] +block = "cell2d" +name = "icvert" +type = "integer" +shape = "(ncvert)" +reader = "urword" +optional = "false" +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." +numeric_index = "true" diff --git a/flopy/mf6/data/dfn/toml/gwt-dsp.toml b/flopy/mf6/data/dfn/toml/gwt-dsp.toml new file mode 100644 index 0000000000..29adc45b4f --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-dsp.toml @@ -0,0 +1,114 @@ +name = "gwt-dsp" +advanced = false +multi = false + +[options.xt3d_off] +block = "options" +name = "xt3d_off" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.xt3d_rhs] +block = "options" +name = "xt3d_rhs" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[griddata.diffc] +block = "griddata" +name = "diffc" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +longname = "effective molecular diffusion coefficient" +description = "effective molecular diffusion coefficient." +layered = true +netcdf = true + +[griddata.alh] +block = "griddata" +name = "alh" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.alv] +block = "griddata" +name = "alv" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.ath1] +block = "griddata" +name = "ath1" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.ath2] +block = "griddata" +name = "ath2" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true + +[griddata.atv] +block = "griddata" +name = "atv" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true +netcdf = true diff --git a/flopy/mf6/data/dfn/toml/gwt-fmi.toml b/flopy/mf6/data/dfn/toml/gwt-fmi.toml new file mode 100644 index 0000000000..62478f530d --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-fmi.toml @@ -0,0 +1,62 @@ +name = "gwt-fmi" +advanced = false +multi = false + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.flow_imbalance_correction] +block = "options" +name = "flow_imbalance_correction" +type = "keyword" +reader = "urword" +optional = true +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." + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +reader = "urword" +optional = false +longname = "flowtype list" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" +optional = false +longname = "flowtype list" + +[packagedata.packagedata.item.fields.flowtype] +block = "packagedata" +name = "flowtype" +type = "string" +reader = "urword" +longname = "flow type" +description = "is the word GWFBUDGET, GWFHEAD, 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." + +[packagedata.packagedata.item.fields.filein] +block = "packagedata" +name = "filein" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an input filename is expected next." + +[packagedata.packagedata.item.fields.fname] +block = "packagedata" +name = "fname" +type = "string" +reader = "urword" +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." diff --git a/flopy/mf6/data/dfn/toml/gwt-ic.toml b/flopy/mf6/data/dfn/toml/gwt-ic.toml new file mode 100644 index 0000000000..5dc51173f4 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-ic.toml @@ -0,0 +1,36 @@ +name = "gwt-ic" +advanced = false +multi = false + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" +extended = true + +[griddata.strt] +block = "griddata" +name = "strt" +type = "double precision" +shape = "(nodes)" +default = 0.0 +reader = "readarray" +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." +layered = true +netcdf = true diff --git a/flopy/mf6/data/dfn/toml/gwt-ist.toml b/flopy/mf6/data/dfn/toml/gwt-ist.toml new file mode 100644 index 0000000000..b02c15853f --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-ist.toml @@ -0,0 +1,279 @@ +name = "gwt-ist" +advanced = false +multi = false + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.sorption] +block = "options" +name = "sorption" +type = "string" +reader = "urword" +optional = true +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." +valid = "linear freundlich langmuir" + +[options.first_order_decay] +block = "options" +name = "first_order_decay" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.zero_order_decay] +block = "options" +name = "zero_order_decay" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.cim_filerecord] +block = "options" +name = "cim_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.cim_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.cim_filerecord.fields.cimfile] +block = "options" +name = "cimfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.cimprintrecord] +block = "options" +name = "cimprintrecord" +type = "record" +reader = "urword" +optional = true + +[options.cimprintrecord.fields.print_format] +block = "options" +name = "print_format" +type = "keyword" +reader = "urword" +optional = "false" +longname = "keyword to indicate that a print format follows" +description = "keyword to specify format for printing to the listing file." + +[options.sorbate_filerecord] +block = "options" +name = "sorbate_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.sorbate_filerecord.fields.sorbate] +block = "options" +name = "sorbate" +type = "keyword" +reader = "urword" +optional = "false" +longname = "sorbate keyword" +description = "keyword to specify that record corresponds to immobile sorbate concentration." + +[options.sorbate_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.sorbate_filerecord.fields.sorbatefile] +block = "options" +name = "sorbatefile" +type = "string" +reader = "urword" +optional = "false" +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." + +[griddata.porosity] +block = "griddata" +name = "porosity" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +longname = "porosity of the immobile domain" +description = "porosity of the immobile domain specified as the immobile domain pore volume per immobile domain volume." +layered = true + +[griddata.volfrac] +block = "griddata" +name = "volfrac" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +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." +layered = true + +[griddata.zetaim] +block = "griddata" +name = "zetaim" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +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." +layered = true + +[griddata.cim] +block = "griddata" +name = "cim" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true + +[griddata.decay] +block = "griddata" +name = "decay" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true + +[griddata.decay_sorbed] +block = "griddata" +name = "decay_sorbed" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true + +[griddata.bulk_density] +block = "griddata" +name = "bulk_density" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true + +[griddata.distcoef] +block = "griddata" +name = "distcoef" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true + +[griddata.sp2] +block = "griddata" +name = "sp2" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true diff --git a/flopy/mf6/data/dfn/toml/gwt-lkt.toml b/flopy/mf6/data/dfn/toml/gwt-lkt.toml new file mode 100644 index 0000000000..8a6ecf4912 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-lkt.toml @@ -0,0 +1,386 @@ +name = "gwt-lkt" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.flow_package_name] +block = "options" +name = "flow_package_name" +type = "string" +reader = "urword" +optional = true +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)." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.flow_package_auxiliary_name] +block = "options" +name = "flow_package_auxiliary_name" +type = "string" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of lake cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_concentration] +block = "options" +name = "print_concentration" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.concentration_filerecord] +block = "options" +name = "concentration_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.concentration_filerecord.fields.concentration] +block = "period" +name = "concentration" +type = "string" +time_series = "true" +reader = "urword" +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." + +[options.concentration_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.concentration_filerecord.fields.concfile] +block = "options" +name = "concfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write concentration information." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.strt] +block = "packagedata" +name = "strt" +type = "double precision" +reader = "urword" +longname = "starting lake concentration" +description = "real value that defines the starting concentration for the lake." + +[packagedata.packagedata.item.fields.aux] +block = "packagedata" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +time_series = "true" +optional = "true" +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." + +[packagedata.packagedata.item.fields.boundname] +block = "packagedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." + +[period] +transient_block = true + +[period.lakeperioddata] +block = "period" +name = "lakeperioddata" +type = "list" +reader = "urword" + +[period.lakeperioddata.item] +name = "lakeperioddata" +type = "record" +block = "period" +reader = "urword" + +[period.lakeperioddata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = true + +[period.lakeperioddata.item.fields.laksetting] +block = "period" +name = "laksetting" +type = "union" +reader = "urword" +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." + +[period.lakeperioddata.item.fields.laksetting.choices.concentration] +block = "period" +name = "concentration" +type = "string" +reader = "urword" +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 + +[period.lakeperioddata.item.fields.laksetting.choices.status] +block = "period" +name = "status" +type = "string" +reader = "urword" +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." + +[period.lakeperioddata.item.fields.laksetting.choices.rainfall] +block = "period" +name = "rainfall" +type = "string" +reader = "urword" +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 + +[period.lakeperioddata.item.fields.laksetting.choices.evaporation] +block = "period" +name = "evaporation" +type = "string" +reader = "urword" +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 + +[period.lakeperioddata.item.fields.laksetting.choices.runoff] +block = "period" +name = "runoff" +type = "string" +reader = "urword" +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 + +[period.lakeperioddata.item.fields.laksetting.choices.ext-inflow] +block = "period" +name = "ext-inflow" +type = "string" +reader = "urword" +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 + +[period.lakeperioddata.item.fields.laksetting.choices.auxiliaryrecord] +block = "period" +name = "auxiliaryrecord" +type = "record" +reader = "urword" + +[period.lakeperioddata.item.fields.laksetting.choices.auxiliaryrecord.fields.auxiliary] +block = "period" +name = "auxiliary" +type = "keyword" +reader = "urword" +description = "keyword for specifying auxiliary variable." + +[period.lakeperioddata.item.fields.laksetting.choices.auxiliaryrecord.fields.auxname] +block = "period" +name = "auxname" +type = "string" +reader = "urword" +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." + +[period.lakeperioddata.item.fields.laksetting.choices.auxiliaryrecord.fields.auxval] +block = "period" +name = "auxval" +type = "double precision" +reader = "urword" +time_series = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwt-mst.toml b/flopy/mf6/data/dfn/toml/gwt-mst.toml new file mode 100644 index 0000000000..4d29414a95 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-mst.toml @@ -0,0 +1,139 @@ +name = "gwt-mst" +advanced = false +multi = false + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.first_order_decay] +block = "options" +name = "first_order_decay" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.zero_order_decay] +block = "options" +name = "zero_order_decay" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.sorption] +block = "options" +name = "sorption" +type = "string" +reader = "urword" +optional = true +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." +valid = "linear freundlich langmuir" + +[options.sorbate_filerecord] +block = "options" +name = "sorbate_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.sorbate_filerecord.fields.sorbate] +block = "options" +name = "sorbate" +type = "keyword" +reader = "urword" +optional = "false" +longname = "sorbate keyword" +description = "keyword to specify that record corresponds to sorbate concentration." + +[options.sorbate_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.sorbate_filerecord.fields.sorbatefile] +block = "options" +name = "sorbatefile" +type = "string" +reader = "urword" +optional = "false" +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." + +[griddata.porosity] +block = "griddata" +name = "porosity" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +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." +layered = true + +[griddata.decay] +block = "griddata" +name = "decay" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true + +[griddata.decay_sorbed] +block = "griddata" +name = "decay_sorbed" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true + +[griddata.bulk_density] +block = "griddata" +name = "bulk_density" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true + +[griddata.distcoef] +block = "griddata" +name = "distcoef" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true + +[griddata.sp2] +block = "griddata" +name = "sp2" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true diff --git a/flopy/mf6/data/dfn/toml/gwt-mvt.toml b/flopy/mf6/data/dfn/toml/gwt-mvt.toml new file mode 100644 index 0000000000..def3893b40 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-mvt.toml @@ -0,0 +1,105 @@ +name = "gwt-mvt" +advanced = false +multi = false + +[ref] +parent = "parent_model_or_package" +key = "mvt_filerecord" +val = "perioddata" +abbr = "mvt" +param = "perioddata" + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." diff --git a/flopy/mf6/data/dfn/toml/gwt-mwt.toml b/flopy/mf6/data/dfn/toml/gwt-mwt.toml new file mode 100644 index 0000000000..937d0321dc --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-mwt.toml @@ -0,0 +1,359 @@ +name = "gwt-mwt" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.flow_package_name] +block = "options" +name = "flow_package_name" +type = "string" +reader = "urword" +optional = true +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)." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.flow_package_auxiliary_name] +block = "options" +name = "flow_package_auxiliary_name" +type = "string" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of well cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_concentration] +block = "options" +name = "print_concentration" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.concentration_filerecord] +block = "options" +name = "concentration_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.concentration_filerecord.fields.concentration] +block = "period" +name = "concentration" +type = "string" +time_series = "true" +reader = "urword" +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." + +[options.concentration_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.concentration_filerecord.fields.concfile] +block = "options" +name = "concfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write concentration information." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.strt] +block = "packagedata" +name = "strt" +type = "double precision" +reader = "urword" +longname = "starting well concentration" +description = "real value that defines the starting concentration for the well." + +[packagedata.packagedata.item.fields.aux] +block = "packagedata" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +time_series = "true" +optional = "true" +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." + +[packagedata.packagedata.item.fields.boundname] +block = "packagedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." + +[period] +transient_block = true + +[period.mwtperioddata] +block = "period" +name = "mwtperioddata" +type = "list" +reader = "urword" + +[period.mwtperioddata.item] +name = "mwtperioddata" +type = "record" +block = "period" +reader = "urword" + +[period.mwtperioddata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = true + +[period.mwtperioddata.item.fields.mwtsetting] +block = "period" +name = "mwtsetting" +type = "union" +reader = "urword" +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." + +[period.mwtperioddata.item.fields.mwtsetting.choices.concentration] +block = "period" +name = "concentration" +type = "string" +reader = "urword" +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 + +[period.mwtperioddata.item.fields.mwtsetting.choices.status] +block = "period" +name = "status" +type = "string" +reader = "urword" +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." + +[period.mwtperioddata.item.fields.mwtsetting.choices.rate] +block = "period" +name = "rate" +type = "string" +reader = "urword" +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 + +[period.mwtperioddata.item.fields.mwtsetting.choices.auxiliaryrecord] +block = "period" +name = "auxiliaryrecord" +type = "record" +reader = "urword" + +[period.mwtperioddata.item.fields.mwtsetting.choices.auxiliaryrecord.fields.auxiliary] +block = "period" +name = "auxiliary" +type = "keyword" +reader = "urword" +description = "keyword for specifying auxiliary variable." + +[period.mwtperioddata.item.fields.mwtsetting.choices.auxiliaryrecord.fields.auxname] +block = "period" +name = "auxname" +type = "string" +reader = "urword" +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." + +[period.mwtperioddata.item.fields.mwtsetting.choices.auxiliaryrecord.fields.auxval] +block = "period" +name = "auxval" +type = "double precision" +reader = "urword" +time_series = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwt-nam.toml b/flopy/mf6/data/dfn/toml/gwt-nam.toml new file mode 100644 index 0000000000..de52cd6507 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-nam.toml @@ -0,0 +1,195 @@ +name = "gwt-nam" +advanced = false +multi = false + +[options.list] +block = "options" +name = "list" +type = "string" +reader = "urword" +optional = true +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'." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.nc_mesh2d_filerecord] +block = "options" +name = "nc_mesh2d_filerecord" +type = "record" +reader = "urword" +optional = true +description = "netcdf layered mesh fileout record." +mf6internal = "ncmesh2drec" + +[options.nc_mesh2d_filerecord.fields.netcdf_mesh2d] +block = "options" +name = "netcdf_mesh2d" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to a layered mesh netcdf file." +extended = "true" + +[options.nc_mesh2d_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.nc_mesh2d_filerecord.fields.ncmesh2dfile] +block = "options" +name = "ncmesh2dfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the netcdf ugrid layered mesh output file." +extended = "true" + +[options.nc_structured_filerecord] +block = "options" +name = "nc_structured_filerecord" +type = "record" +reader = "urword" +optional = true +description = "netcdf structured fileout record." +mf6internal = "ncstructrec" + +[options.nc_structured_filerecord.fields.netcdf_structured] +block = "options" +name = "netcdf_structured" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to a structured netcdf file." +mf6internal = "netcdf_struct" +extended = "true" + +[options.nc_structured_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.nc_structured_filerecord.fields.ncstructfile] +block = "options" +name = "ncstructfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the netcdf structured output file." +extended = "true" + +[options.nc_filerecord] +block = "options" +name = "nc_filerecord" +type = "record" +reader = "urword" +optional = true +description = "netcdf filerecord" + +[options.nc_filerecord.fields.netcdf] +block = "options" +name = "netcdf" +type = "keyword" +reader = "urword" +optional = "false" +longname = "netcdf keyword" +description = "keyword to specify that record corresponds to a netcdf input file." +extended = "true" + +[options.nc_filerecord.fields.filein] +block = "options" +name = "filein" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an input filename is expected next." + +[options.nc_filerecord.fields.netcdf_filename] +block = "options" +name = "netcdf_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "netcdf input filename" +description = "defines a netcdf input file." +mf6internal = "netcdf_fname" +extended = "true" + +[packages.packages] +block = "packages" +name = "packages" +type = "list" +reader = "urword" +optional = false +longname = "package list" + +[packages.packages.item] +name = "packages" +type = "record" +block = "packages" +reader = "urword" +optional = false +longname = "package list" + +[packages.packages.item.fields.ftype] +block = "packages" +name = "ftype" +type = "string" +reader = "urword" +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." + +[packages.packages.item.fields.fname] +block = "packages" +name = "fname" +type = "string" +reader = "urword" +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." + +[packages.packages.item.fields.pname] +block = "packages" +name = "pname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwt-oc.toml b/flopy/mf6/data/dfn/toml/gwt-oc.toml new file mode 100644 index 0000000000..e0c2ed47e4 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-oc.toml @@ -0,0 +1,197 @@ +name = "gwt-oc" +advanced = false +multi = false + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.concentration_filerecord] +block = "options" +name = "concentration_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.concentration_filerecord.fields.concentration] +block = "options" +name = "concentration" +type = "keyword" +reader = "urword" +optional = "false" +longname = "concentration keyword" +description = "keyword to specify that record corresponds to concentration." + +[options.concentration_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.concentration_filerecord.fields.concentrationfile] +block = "options" +name = "concentrationfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the output file to write conc information." + +[options.concentrationprintrecord] +block = "options" +name = "concentrationprintrecord" +type = "record" +reader = "urword" +optional = true + +[options.concentrationprintrecord.fields.concentration] +block = "options" +name = "concentration" +type = "keyword" +reader = "urword" +optional = "false" +longname = "concentration keyword" +description = "keyword to specify that record corresponds to concentration." + +[options.concentrationprintrecord.fields.print_format] +block = "options" +name = "print_format" +type = "keyword" +reader = "urword" +optional = "false" +longname = "keyword to indicate that a print format follows" +description = "keyword to specify format for printing to the listing file." + +[period] +transient_block = true + +[period.saverecord] +block = "period" +name = "saverecord" +type = "record" +reader = "urword" +optional = true + +[period.saverecord.fields.save] +block = "period" +name = "save" +type = "keyword" +reader = "urword" +optional = "false" +longname = "keyword to save" +description = "keyword to indicate that information will be saved this stress period." + +[period.saverecord.fields.rtype] +block = "period" +name = "rtype" +type = "string" +reader = "urword" +optional = "false" +longname = "record type" +description = "type of information to save or print. Can be BUDGET or CONCENTRATION." + +[period.saverecord.fields.ocsetting] +block = "period" +name = "ocsetting" +type = "keystring all first last frequency steps" +reader = "urword" +description = "specifies the steps for which the data will be saved." + +[period.printrecord] +block = "period" +name = "printrecord" +type = "record" +reader = "urword" +optional = true + +[period.printrecord.fields.print] +block = "period" +name = "print" +type = "keyword" +reader = "urword" +optional = "false" +longname = "keyword to save" +description = "keyword to indicate that information will be printed this stress period." + +[period.printrecord.fields.rtype] +block = "period" +name = "rtype" +type = "string" +reader = "urword" +optional = "false" +longname = "record type" +description = "type of information to save or print. Can be BUDGET or CONCENTRATION." + +[period.printrecord.fields.ocsetting] +block = "period" +name = "ocsetting" +type = "keystring all first last frequency steps" +reader = "urword" +description = "specifies the steps for which the data will be saved." diff --git a/flopy/mf6/data/dfn/toml/gwt-sft.toml b/flopy/mf6/data/dfn/toml/gwt-sft.toml new file mode 100644 index 0000000000..4b98335108 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-sft.toml @@ -0,0 +1,386 @@ +name = "gwt-sft" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.flow_package_name] +block = "options" +name = "flow_package_name" +type = "string" +reader = "urword" +optional = true +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)." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.flow_package_auxiliary_name] +block = "options" +name = "flow_package_auxiliary_name" +type = "string" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of reach cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_concentration] +block = "options" +name = "print_concentration" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.concentration_filerecord] +block = "options" +name = "concentration_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.concentration_filerecord.fields.concentration] +block = "period" +name = "concentration" +type = "string" +time_series = "true" +reader = "urword" +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." + +[options.concentration_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.concentration_filerecord.fields.concfile] +block = "options" +name = "concfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write concentration information." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.strt] +block = "packagedata" +name = "strt" +type = "double precision" +reader = "urword" +longname = "starting reach concentration" +description = "real value that defines the starting concentration for the reach." + +[packagedata.packagedata.item.fields.aux] +block = "packagedata" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +time_series = "true" +optional = "true" +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." + +[packagedata.packagedata.item.fields.boundname] +block = "packagedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." + +[period] +transient_block = true + +[period.reachperioddata] +block = "period" +name = "reachperioddata" +type = "list" +reader = "urword" + +[period.reachperioddata.item] +name = "reachperioddata" +type = "record" +block = "period" +reader = "urword" + +[period.reachperioddata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = true + +[period.reachperioddata.item.fields.reachsetting] +block = "period" +name = "reachsetting" +type = "union" +reader = "urword" +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." + +[period.reachperioddata.item.fields.reachsetting.choices.concentration] +block = "period" +name = "concentration" +type = "string" +reader = "urword" +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 + +[period.reachperioddata.item.fields.reachsetting.choices.status] +block = "period" +name = "status" +type = "string" +reader = "urword" +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." + +[period.reachperioddata.item.fields.reachsetting.choices.rainfall] +block = "period" +name = "rainfall" +type = "string" +reader = "urword" +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 + +[period.reachperioddata.item.fields.reachsetting.choices.evaporation] +block = "period" +name = "evaporation" +type = "string" +reader = "urword" +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 + +[period.reachperioddata.item.fields.reachsetting.choices.runoff] +block = "period" +name = "runoff" +type = "string" +reader = "urword" +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 + +[period.reachperioddata.item.fields.reachsetting.choices.inflow] +block = "period" +name = "inflow" +type = "string" +reader = "urword" +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 + +[period.reachperioddata.item.fields.reachsetting.choices.auxiliaryrecord] +block = "period" +name = "auxiliaryrecord" +type = "record" +reader = "urword" + +[period.reachperioddata.item.fields.reachsetting.choices.auxiliaryrecord.fields.auxiliary] +block = "period" +name = "auxiliary" +type = "keyword" +reader = "urword" +description = "keyword for specifying auxiliary variable." + +[period.reachperioddata.item.fields.reachsetting.choices.auxiliaryrecord.fields.auxname] +block = "period" +name = "auxname" +type = "string" +reader = "urword" +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." + +[period.reachperioddata.item.fields.reachsetting.choices.auxiliaryrecord.fields.auxval] +block = "period" +name = "auxval" +type = "double precision" +reader = "urword" +time_series = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwt-src.toml b/flopy/mf6/data/dfn/toml/gwt-src.toml new file mode 100644 index 0000000000..a46268950b --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-src.toml @@ -0,0 +1,166 @@ +name = "gwt-src" +advanced = false +multi = false + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.auxmultname] +block = "options" +name = "auxmultname" +type = "string" +reader = "urword" +optional = true +longname = "name of auxiliary variable for multiplier" +description = "name of auxiliary variable to be used as multiplier of mass loading rate." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of mass source cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +longname = "save well 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." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[dimensions.maxbound] +block = "dimensions" +name = "maxbound" +type = "integer" +reader = "urword" +optional = false +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." + +[period] +transient_block = true + +[period.stress_period_data] +block = "period" +name = "stress_period_data" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[period.stress_period_data.item] +name = "stress_period_data" +type = "record" +block = "period" +reader = "urword" + +[period.stress_period_data.item.fields.cellid] +block = "period" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[period.stress_period_data.item.fields.smassrate] +block = "period" +name = "smassrate" +type = "double precision" +reader = "urword" +time_series = "true" +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." + +[period.stress_period_data.item.fields.aux] +block = "period" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +optional = "true" +time_series = "true" +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." + +[period.stress_period_data.item.fields.boundname] +block = "period" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +longname = "well 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." diff --git a/flopy/mf6/data/dfn/toml/gwt-ssm.toml b/flopy/mf6/data/dfn/toml/gwt-ssm.toml new file mode 100644 index 0000000000..3c89fd5c1c --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-ssm.toml @@ -0,0 +1,119 @@ +name = "gwt-ssm" +advanced = false +multi = false + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[sources.sources] +block = "sources" +name = "sources" +type = "list" +reader = "urword" +optional = false +longname = "package list" + +[sources.sources.item] +name = "sources" +type = "record" +block = "sources" +reader = "urword" +optional = false +longname = "package list" + +[sources.sources.item.fields.pname] +block = "fileinput" +name = "pname" +type = "string" +reader = "urword" +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." + +[sources.sources.item.fields.srctype] +block = "sources" +name = "srctype" +type = "string" +optional = "false" +reader = "urword" +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." + +[sources.sources.item.fields.auxname] +block = "sources" +name = "auxname" +type = "string" +reader = "urword" +optional = "false" +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." + +[fileinput.fileinput] +block = "fileinput" +name = "fileinput" +type = "list" +reader = "urword" + +[fileinput.fileinput.item] +name = "fileinput" +type = "record" +block = "fileinput" +reader = "urword" + +[fileinput.fileinput.item.fields.pname] +block = "fileinput" +name = "pname" +type = "string" +reader = "urword" +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." + +[fileinput.fileinput.item.fields.spc6] +block = "fileinput" +name = "spc6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "head keyword" +description = "keyword to specify that record corresponds to a source sink mixing input file." + +[fileinput.fileinput.item.fields.filein] +block = "fileinput" +name = "filein" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an input filename is expected next." + +[fileinput.fileinput.item.fields.spc6_filename] +block = "fileinput" +name = "spc6_filename" +type = "string" +reader = "urword" +optional = "false" +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." + +[fileinput.fileinput.item.fields.mixed] +block = "fileinput" +name = "mixed" +type = "keyword" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/gwt-uzt.toml b/flopy/mf6/data/dfn/toml/gwt-uzt.toml new file mode 100644 index 0000000000..58bbd82f48 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/gwt-uzt.toml @@ -0,0 +1,368 @@ +name = "gwt-uzt" +advanced = false +multi = true + +[fkeys.ts_filerecord] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[fkeys.obs_filerecord] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[options.flow_package_name] +block = "options" +name = "flow_package_name" +type = "string" +reader = "urword" +optional = true +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)." + +[options.auxiliary] +block = "options" +name = "auxiliary" +type = "string" +shape = "(naux)" +reader = "urword" +optional = true +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." + +[options.flow_package_auxiliary_name] +block = "options" +name = "flow_package_auxiliary_name" +type = "string" +reader = "urword" +optional = true +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." + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of unsaturated zone flow cells." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_concentration] +block = "options" +name = "print_concentration" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.concentration_filerecord] +block = "options" +name = "concentration_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.concentration_filerecord.fields.concentration] +block = "period" +name = "concentration" +type = "string" +time_series = "true" +reader = "urword" +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." + +[options.concentration_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.concentration_filerecord.fields.concfile] +block = "options" +name = "concfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write concentration information." + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.timeseries] +block = "options" +name = "timeseries" +type = "record ts6 filein ts6_filename" +reader = "urword" +optional = true +description = "Contains data for the ts package. Data can be passed as a dictionary to the ts package with variable names as keys and package data as values. Data for the timeseries variable is also acceptable. See ts package documentation for more information." + +[options.timeseries.ref] +parent = "parent_package" +key = "ts_filerecord" +val = "timeseries" +abbr = "ts" +param = "timeseries" +description = "xxx" + +[options.observations] +block = "options" +name = "observations" +type = "record obs6 filein obs6_filename" +reader = "urword" +optional = true +description = "Contains data for the obs package. Data can be passed as a dictionary to the obs package with variable names as keys and package data as values. Data for the observations variable is also acceptable. See obs package documentation for more information." + +[options.observations.ref] +parent = "parent_model_or_package" +key = "obs_filerecord" +val = "observations" +abbr = "obs" +param = "continuous" + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(maxbound)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.strt] +block = "packagedata" +name = "strt" +type = "double precision" +reader = "urword" +longname = "starting UZF cell concentration" +description = "real value that defines the starting concentration for the unsaturated zone flow cell." + +[packagedata.packagedata.item.fields.aux] +block = "packagedata" +name = "aux" +type = "double precision" +shape = "(naux)" +reader = "urword" +time_series = "true" +optional = "true" +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." + +[packagedata.packagedata.item.fields.boundname] +block = "packagedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." + +[period] +transient_block = true + +[period.uztperioddata] +block = "period" +name = "uztperioddata" +type = "list" +reader = "urword" + +[period.uztperioddata.item] +name = "uztperioddata" +type = "record" +block = "period" +reader = "urword" + +[period.uztperioddata.item.fields.ifno] +block = "period" +name = "ifno" +type = "integer" +reader = "urword" +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." +numeric_index = true + +[period.uztperioddata.item.fields.uztsetting] +block = "period" +name = "uztsetting" +type = "union" +reader = "urword" +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." + +[period.uztperioddata.item.fields.uztsetting.choices.concentration] +block = "period" +name = "concentration" +type = "string" +reader = "urword" +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 + +[period.uztperioddata.item.fields.uztsetting.choices.status] +block = "period" +name = "status" +type = "string" +reader = "urword" +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." + +[period.uztperioddata.item.fields.uztsetting.choices.infiltration] +block = "period" +name = "infiltration" +type = "string" +reader = "urword" +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 + +[period.uztperioddata.item.fields.uztsetting.choices.uzet] +block = "period" +name = "uzet" +type = "string" +reader = "urword" +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 + +[period.uztperioddata.item.fields.uztsetting.choices.auxiliaryrecord] +block = "period" +name = "auxiliaryrecord" +type = "record" +reader = "urword" + +[period.uztperioddata.item.fields.uztsetting.choices.auxiliaryrecord.fields.auxiliary] +block = "period" +name = "auxiliary" +type = "keyword" +reader = "urword" +description = "keyword for specifying auxiliary variable." + +[period.uztperioddata.item.fields.uztsetting.choices.auxiliaryrecord.fields.auxname] +block = "period" +name = "auxname" +type = "string" +reader = "urword" +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." + +[period.uztperioddata.item.fields.uztsetting.choices.auxiliaryrecord.fields.auxval] +block = "period" +name = "auxval" +type = "double precision" +reader = "urword" +time_series = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/prt-dis.toml b/flopy/mf6/data/dfn/toml/prt-dis.toml new file mode 100644 index 0000000000..43d5d8ec64 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/prt-dis.toml @@ -0,0 +1,208 @@ +name = "prt-dis" +advanced = false +multi = false + +[fkeys.ncf_filerecord] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[options.length_units] +block = "options" +name = "length_units" +type = "string" +reader = "urword" +optional = true +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'." + +[options.nogrb] +block = "options" +name = "nogrb" +type = "keyword" +reader = "urword" +optional = true +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." + +[options.grb_filerecord] +block = "options" +name = "grb_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.grb_filerecord.fields.grb6] +block = "options" +name = "grb6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." +extended = "true" + +[options.grb_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.grb_filerecord.fields.grb6_filename] +block = "options" +name = "grb6_filename" +type = "string" +reader = "urword" +optional = "false" +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'." +extended = "true" + +[options.xorigin] +block = "options" +name = "xorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.yorigin] +block = "options" +name = "yorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.angrot] +block = "options" +name = "angrot" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" + +[options.packagedata] +block = "options" +name = "packagedata" +type = "record ncf6 filein ncf6_filename" +reader = "urword" +optional = true +description = "Contains data for the ncf package. Data can be passed as a dictionary to the ncf package with variable names as keys and package data as values. Data for the packagedata variable is also acceptable. See ncf package documentation for more information." + +[options.packagedata.ref] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[dimensions.nlay] +block = "dimensions" +name = "nlay" +type = "integer" +default = 1 +reader = "urword" +optional = false +longname = "number of layers" +description = "is the number of layers in the model grid." + +[dimensions.nrow] +block = "dimensions" +name = "nrow" +type = "integer" +default = 2 +reader = "urword" +optional = false +longname = "number of rows" +description = "is the number of rows in the model grid." + +[dimensions.ncol] +block = "dimensions" +name = "ncol" +type = "integer" +default = 2 +reader = "urword" +optional = false +longname = "number of columns" +description = "is the number of columns in the model grid." + +[griddata.delr] +block = "griddata" +name = "delr" +type = "double precision" +shape = "(ncol)" +default = 1.0 +reader = "readarray" +longname = "spacing along a row" +description = "is the column spacing in the row direction." + +[griddata.delc] +block = "griddata" +name = "delc" +type = "double precision" +shape = "(nrow)" +default = 1.0 +reader = "readarray" +longname = "spacing along a column" +description = "is the row spacing in the column direction." + +[griddata.top] +block = "griddata" +name = "top" +type = "double precision" +shape = "(ncol, nrow)" +default = 1.0 +reader = "readarray" +longname = "cell top elevation" +description = "is the top elevation for each cell in the top model layer." + +[griddata.botm] +block = "griddata" +name = "botm" +type = "double precision" +shape = "(ncol, nrow, nlay)" +default = 0.0 +reader = "readarray" +longname = "cell bottom elevation" +description = "is the bottom elevation for each cell." +layered = true + +[griddata.idomain] +block = "griddata" +name = "idomain" +type = "integer" +shape = "(ncol, nrow, nlay)" +reader = "readarray" +optional = true +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." +layered = true diff --git a/flopy/mf6/data/dfn/toml/prt-disv.toml b/flopy/mf6/data/dfn/toml/prt-disv.toml new file mode 100644 index 0000000000..9003f17719 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/prt-disv.toml @@ -0,0 +1,293 @@ +name = "prt-disv" +advanced = false +multi = false + +[fkeys.ncf_filerecord] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[options.length_units] +block = "options" +name = "length_units" +type = "string" +reader = "urword" +optional = true +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'." + +[options.nogrb] +block = "options" +name = "nogrb" +type = "keyword" +reader = "urword" +optional = true +longname = "do not write binary grid file" +description = "keyword to deactivate writing of the binary grid file." + +[options.grb_filerecord] +block = "options" +name = "grb_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.grb_filerecord.fields.grb6] +block = "options" +name = "grb6" +type = "keyword" +reader = "urword" +optional = "false" +longname = "grb keyword" +description = "keyword to specify that record corresponds to a binary grid file." +extended = "true" + +[options.grb_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next. If this option is not provided, the output file will have the same name as the discretization input file, plus extension '.grb'." + +[options.grb_filerecord.fields.grb6_filename] +block = "options" +name = "grb6_filename" +type = "string" +reader = "urword" +optional = "false" +longname = "file name of GRB information" +description = "defines a binary grid output file." +extended = "true" + +[options.xorigin] +block = "options" +name = "xorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.yorigin] +block = "options" +name = "yorigin" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.angrot] +block = "options" +name = "angrot" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[options.export_array_netcdf] +block = "options" +name = "export_array_netcdf" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to netcdf output files." +description = "keyword that specifies input griddata arrays should be written to the model output netcdf file." +mf6internal = "export_nc" + +[options.packagedata] +block = "options" +name = "packagedata" +type = "record ncf6 filein ncf6_filename" +reader = "urword" +optional = true +description = "Contains data for the ncf package. Data can be passed as a dictionary to the ncf package with variable names as keys and package data as values. Data for the packagedata variable is also acceptable. See ncf package documentation for more information." + +[options.packagedata.ref] +parent = "parent_package" +key = "ncf_filerecord" +val = "packagedata" +abbr = "ncf" +param = "packagedata" + +[dimensions.nlay] +block = "dimensions" +name = "nlay" +type = "integer" +reader = "urword" +optional = false +longname = "number of layers" +description = "is the number of layers in the model grid." + +[dimensions.ncpl] +block = "dimensions" +name = "ncpl" +type = "integer" +reader = "urword" +optional = false +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." + +[dimensions.nvert] +block = "dimensions" +name = "nvert" +type = "integer" +reader = "urword" +optional = false +longname = "number of columns" +description = "is the total number of (x, y) vertex pairs used to characterize the horizontal configuration of the model grid." + +[griddata.top] +block = "griddata" +name = "top" +type = "double precision" +shape = "(ncpl)" +reader = "readarray" +longname = "model top elevation" +description = "is the top elevation for each cell in the top model layer." + +[griddata.botm] +block = "griddata" +name = "botm" +type = "double precision" +shape = "(ncpl, nlay)" +reader = "readarray" +longname = "model bottom elevation" +description = "is the bottom elevation for each cell." +layered = true + +[griddata.idomain] +block = "griddata" +name = "idomain" +type = "integer" +shape = "(ncpl, nlay)" +reader = "readarray" +optional = true +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." +layered = true + +[vertices.vertices] +block = "vertices" +name = "vertices" +type = "list" +shape = "(nvert)" +reader = "urword" +optional = false +longname = "vertices data" + +[vertices.vertices.item] +name = "vertices" +type = "record" +block = "vertices" +reader = "urword" +optional = false +longname = "vertices data" + +[vertices.vertices.item.fields.iv] +block = "vertices" +name = "iv" +type = "integer" +reader = "urword" +optional = "false" +longname = "vertex number" +description = "is the vertex number. Records in the VERTICES block must be listed in consecutive order from 1 to NVERT." +numeric_index = "true" + +[vertices.vertices.item.fields.xv] +block = "vertices" +name = "xv" +type = "double precision" +reader = "urword" +optional = "false" +longname = "x-coordinate for vertex" +description = "is the x-coordinate for the vertex." + +[vertices.vertices.item.fields.yv] +block = "vertices" +name = "yv" +type = "double precision" +reader = "urword" +optional = "false" +longname = "y-coordinate for vertex" +description = "is the y-coordinate for the vertex." + +[cell2d.cell2d] +block = "cell2d" +name = "cell2d" +type = "list" +shape = "(ncpl)" +reader = "urword" +optional = false +longname = "cell2d data" + +[cell2d.cell2d.item] +name = "cell2d" +type = "record" +block = "cell2d" +reader = "urword" +optional = false +longname = "cell2d data" + +[cell2d.cell2d.item.fields.icell2d] +block = "cell2d" +name = "icell2d" +type = "integer" +reader = "urword" +optional = "false" +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." +numeric_index = "true" + +[cell2d.cell2d.item.fields.xc] +block = "cell2d" +name = "xc" +type = "double precision" +reader = "urword" +optional = "false" +longname = "x-coordinate for cell center" +description = "is the x-coordinate for the cell center." + +[cell2d.cell2d.item.fields.yc] +block = "cell2d" +name = "yc" +type = "double precision" +reader = "urword" +optional = "false" +longname = "y-coordinate for cell center" +description = "is the y-coordinate for the cell center." + +[cell2d.cell2d.item.fields.ncvert] +block = "cell2d" +name = "ncvert" +type = "integer" +reader = "urword" +optional = "false" +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." + +[cell2d.cell2d.item.fields.icvert] +block = "cell2d" +name = "icvert" +type = "integer" +shape = "(ncvert)" +reader = "urword" +optional = "false" +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." +numeric_index = "true" diff --git a/flopy/mf6/data/dfn/toml/prt-fmi.toml b/flopy/mf6/data/dfn/toml/prt-fmi.toml new file mode 100644 index 0000000000..f3b51b37be --- /dev/null +++ b/flopy/mf6/data/dfn/toml/prt-fmi.toml @@ -0,0 +1,53 @@ +name = "prt-fmi" +advanced = false +multi = false + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +reader = "urword" +optional = false +longname = "flowtype list" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" +optional = false +longname = "flowtype list" + +[packagedata.packagedata.item.fields.flowtype] +block = "packagedata" +name = "flowtype" +type = "string" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.filein] +block = "packagedata" +name = "filein" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an input filename is expected next." + +[packagedata.packagedata.item.fields.fname] +block = "packagedata" +name = "fname" +type = "string" +reader = "urword" +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." diff --git a/flopy/mf6/data/dfn/toml/prt-mip.toml b/flopy/mf6/data/dfn/toml/prt-mip.toml new file mode 100644 index 0000000000..7b66b9232c --- /dev/null +++ b/flopy/mf6/data/dfn/toml/prt-mip.toml @@ -0,0 +1,45 @@ +name = "prt-mip" +advanced = false +multi = false + +[options.export_array_ascii] +block = "options" +name = "export_array_ascii" +type = "keyword" +reader = "urword" +optional = true +longname = "export array variables to layered ascii files." +description = "keyword that specifies input griddata arrays should be written to layered ascii output files." +mf6internal = "export_ascii" + +[griddata.porosity] +block = "griddata" +name = "porosity" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +longname = "porosity" +description = "is the aquifer porosity." +layered = true + +[griddata.retfactor] +block = "griddata" +name = "retfactor" +type = "double precision" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true + +[griddata.izone] +block = "griddata" +name = "izone" +type = "integer" +shape = "(nodes)" +reader = "readarray" +optional = true +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." +layered = true diff --git a/flopy/mf6/data/dfn/toml/prt-nam.toml b/flopy/mf6/data/dfn/toml/prt-nam.toml new file mode 100644 index 0000000000..1af094d51e --- /dev/null +++ b/flopy/mf6/data/dfn/toml/prt-nam.toml @@ -0,0 +1,80 @@ +name = "prt-nam" +advanced = false +multi = false + +[options.list] +block = "options" +name = "list" +type = "string" +reader = "urword" +optional = true +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'." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.print_flows] +block = "options" +name = "print_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.save_flows] +block = "options" +name = "save_flows" +type = "keyword" +reader = "urword" +optional = true +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." + +[packages.packages] +block = "packages" +name = "packages" +type = "list" +reader = "urword" +optional = false +longname = "package list" + +[packages.packages.item] +name = "packages" +type = "record" +block = "packages" +reader = "urword" +optional = false +longname = "package list" + +[packages.packages.item.fields.ftype] +block = "packages" +name = "ftype" +type = "string" +reader = "urword" +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." + +[packages.packages.item.fields.fname] +block = "packages" +name = "fname" +type = "string" +reader = "urword" +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." + +[packages.packages.item.fields.pname] +block = "packages" +name = "pname" +type = "string" +reader = "urword" +optional = "true" +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." diff --git a/flopy/mf6/data/dfn/toml/prt-oc.toml b/flopy/mf6/data/dfn/toml/prt-oc.toml new file mode 100644 index 0000000000..9b6cd573f1 --- /dev/null +++ b/flopy/mf6/data/dfn/toml/prt-oc.toml @@ -0,0 +1,343 @@ +name = "prt-oc" +advanced = false +multi = false + +[options.budget_filerecord] +block = "options" +name = "budget_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budget_filerecord.fields.budget] +block = "options" +name = "budget" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget." + +[options.budget_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budget_filerecord.fields.budgetfile] +block = "options" +name = "budgetfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the output file to write budget information." + +[options.budgetcsv_filerecord] +block = "options" +name = "budgetcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.budgetcsv_filerecord.fields.budgetcsv] +block = "options" +name = "budgetcsv" +type = "keyword" +reader = "urword" +optional = "false" +longname = "budget keyword" +description = "keyword to specify that record corresponds to the budget CSV." + +[options.budgetcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.budgetcsv_filerecord.fields.budgetcsvfile] +block = "options" +name = "budgetcsvfile" +type = "string" +reader = "urword" +optional = "false" +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." + +[options.track_filerecord] +block = "options" +name = "track_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.track_filerecord.fields.track] +block = "options" +name = "track" +type = "keyword" +reader = "urword" +optional = "false" +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." + +[options.track_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.track_filerecord.fields.trackfile] +block = "options" +name = "trackfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write tracking information." + +[options.trackcsv_filerecord] +block = "options" +name = "trackcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.trackcsv_filerecord.fields.trackcsv] +block = "options" +name = "trackcsv" +type = "keyword" +reader = "urword" +optional = "false" +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." + +[options.trackcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.trackcsv_filerecord.fields.trackcsvfile] +block = "options" +name = "trackcsvfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the comma-separated value (CSV) file to write tracking information." + +[options.track_release] +block = "options" +name = "track_release" +type = "keyword" +reader = "urword" +optional = true +longname = "track release" +description = "keyword to indicate that particle tracking output is to be written when a particle is released" + +[options.track_exit] +block = "options" +name = "track_exit" +type = "keyword" +reader = "urword" +optional = true +longname = "track transitions" +description = "keyword to indicate that particle tracking output is to be written when a particle exits a feature (a model, cell, or subcell)" + +[options.track_timestep] +block = "options" +name = "track_timestep" +type = "keyword" +reader = "urword" +optional = true +longname = "track timestep ends" +description = "keyword to indicate that particle tracking output is to be written at the end of each time step" + +[options.track_terminate] +block = "options" +name = "track_terminate" +type = "keyword" +reader = "urword" +optional = true +longname = "track termination" +description = "keyword to indicate that particle tracking output is to be written when a particle terminates for any reason" + +[options.track_weaksink] +block = "options" +name = "track_weaksink" +type = "keyword" +reader = "urword" +optional = true +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)" + +[options.track_usertime] +block = "options" +name = "track_usertime" +type = "keyword" +reader = "urword" +optional = true +longname = "track usertime" +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." + +[options.track_timesrecord] +block = "options" +name = "track_timesrecord" +type = "record" +reader = "urword" +optional = true +removed = "6.6.1" + +[options.track_timesrecord.fields.track_times] +block = "options" +name = "track_times" +type = "keyword" +reader = "urword" +description = "keyword indicating tracking times will follow" +removed = "6.6.1" + +[options.track_timesrecord.fields.times] +block = "options" +name = "times" +type = "double precision" +shape = "(unknown)" +reader = "urword" +repeating = "true" +longname = "tracking times" +description = "times to track, relative to the beginning of the simulation." +removed = "6.6.1" + +[options.track_timesfilerecord] +block = "options" +name = "track_timesfilerecord" +type = "record" +reader = "urword" +optional = true +removed = "6.6.1" + +[options.track_timesfilerecord.fields.track_timesfile] +block = "options" +name = "track_timesfile" +type = "keyword" +reader = "urword" +description = "keyword indicating tracking times file name will follow" +removed = "6.6.1" + +[options.track_timesfilerecord.fields.timesfile] +block = "options" +name = "timesfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the tracking times file" +removed = "6.6.1" + +[dimensions.ntracktimes] +block = "dimensions" +name = "ntracktimes" +type = "integer" +reader = "urword" +optional = false +longname = "number of particle tracking times" +description = "is the number of user-specified particle tracking times in the tracktimes block." + +[tracktimes.tracktimes] +block = "tracktimes" +name = "tracktimes" +type = "list" +shape = "(ntracktimes)" +reader = "urword" + +[tracktimes.tracktimes.item] +name = "tracktimes" +type = "record" +block = "tracktimes" +reader = "urword" + +[tracktimes.tracktimes.item.fields.time] +block = "tracktimes" +name = "time" +type = "double precision" +reader = "urword" +longname = "release time" +description = "real value that defines the tracking time with respect to the simulation start time." + +[period] +transient_block = true + +[period.saverecord] +block = "period" +name = "saverecord" +type = "record" +reader = "urword" +optional = true + +[period.saverecord.fields.save] +block = "period" +name = "save" +type = "keyword" +reader = "urword" +optional = "false" +longname = "keyword to save" +description = "keyword to indicate that information will be saved this stress period." + +[period.saverecord.fields.rtype] +block = "period" +name = "rtype" +type = "string" +reader = "urword" +optional = "false" +longname = "record type" +description = "type of information to save or print. Can only be BUDGET." + +[period.saverecord.fields.ocsetting] +block = "period" +name = "ocsetting" +type = "keystring all first last frequency steps" +reader = "urword" +description = "specifies the steps for which the data will be saved." + +[period.printrecord] +block = "period" +name = "printrecord" +type = "record" +reader = "urword" +optional = true + +[period.printrecord.fields.print] +block = "period" +name = "print" +type = "keyword" +reader = "urword" +optional = "false" +longname = "keyword to save" +description = "keyword to indicate that information will be printed this stress period." + +[period.printrecord.fields.rtype] +block = "period" +name = "rtype" +type = "string" +reader = "urword" +optional = "false" +longname = "record type" +description = "type of information to save or print. Can only be BUDGET." + +[period.printrecord.fields.ocsetting] +block = "period" +name = "ocsetting" +type = "keystring all first last frequency steps" +reader = "urword" +description = "specifies the steps for which the data will be saved." diff --git a/flopy/mf6/data/dfn/toml/prt-prp.toml b/flopy/mf6/data/dfn/toml/prt-prp.toml new file mode 100644 index 0000000000..6d781e09dc --- /dev/null +++ b/flopy/mf6/data/dfn/toml/prt-prp.toml @@ -0,0 +1,426 @@ +name = "prt-prp" +advanced = false +multi = true + +[options.boundnames] +block = "options" +name = "boundnames" +type = "keyword" +reader = "urword" +optional = true +description = "keyword to indicate that boundary names may be provided with the list of particle release points." + +[options.print_input] +block = "options" +name = "print_input" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.dev_exit_solve_method] +block = "options" +name = "dev_exit_solve_method" +type = "integer" +reader = "urword" +optional = true +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." + +[options.exit_solve_tolerance] +block = "options" +name = "exit_solve_tolerance" +type = "double precision" +default = 1e-05 +reader = "urword" +optional = true +longname = "exit solve tolerance" +description = "the convergence tolerance for iterative solution of particle exit location and time in the generalized pollock's method. a value of 0.00001 works well for many problems, but the value that strikes the best balance between accuracy and runtime is problem-dependent." + +[options.local_z] +block = "options" +name = "local_z" +type = "keyword" +reader = "urword" +optional = true +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 top of the cell. if the cell is partially saturated at release time, the 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." + +[options.extend_tracking] +block = "options" +name = "extend_tracking" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.track_filerecord] +block = "options" +name = "track_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.track_filerecord.fields.track] +block = "options" +name = "track" +type = "keyword" +reader = "urword" +optional = "false" +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." + +[options.track_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.track_filerecord.fields.trackfile] +block = "options" +name = "trackfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the binary output file to write tracking information." + +[options.trackcsv_filerecord] +block = "options" +name = "trackcsv_filerecord" +type = "record" +reader = "urword" +optional = true + +[options.trackcsv_filerecord.fields.trackcsv] +block = "options" +name = "trackcsv" +type = "keyword" +reader = "urword" +optional = "false" +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." + +[options.trackcsv_filerecord.fields.fileout] +block = "options" +name = "fileout" +type = "keyword" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "keyword to specify that an output filename is expected next." + +[options.trackcsv_filerecord.fields.trackcsvfile] +block = "options" +name = "trackcsvfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the comma-separated value (CSV) file to write tracking information." + +[options.stoptime] +block = "options" +name = "stoptime" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.stoptraveltime] +block = "options" +name = "stoptraveltime" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.stop_at_weak_sink] +block = "options" +name = "stop_at_weak_sink" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.istopzone] +block = "options" +name = "istopzone" +type = "integer" +reader = "urword" +optional = true +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." + +[options.drape] +block = "options" +name = "drape" +type = "keyword" +reader = "urword" +optional = true +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." + +[options.release_timesrecord] +block = "options" +name = "release_timesrecord" +type = "record" +reader = "urword" +optional = true +removed = "6.6.1" + +[options.release_timesrecord.fields.release_times] +block = "options" +name = "release_times" +type = "keyword" +reader = "urword" +description = "keyword indicating release times will follow" +removed = "6.6.1" + +[options.release_timesrecord.fields.times] +block = "options" +name = "times" +type = "double precision" +shape = "(unknown)" +reader = "urword" +repeating = "true" +longname = "release times" +description = "times to release, relative to the beginning of the simulation. RELEASE_TIMES and RELEASE_TIMESFILE are mutually exclusive." +removed = "6.6.1" + +[options.release_timesfilerecord] +block = "options" +name = "release_timesfilerecord" +type = "record" +reader = "urword" +optional = true +removed = "6.6.1" + +[options.release_timesfilerecord.fields.release_timesfile] +block = "options" +name = "release_timesfile" +type = "keyword" +reader = "urword" +description = "keyword indicating release times file name will follow" +removed = "6.6.1" + +[options.release_timesfilerecord.fields.timesfile] +block = "options" +name = "timesfile" +type = "string" +reader = "urword" +optional = "false" +longname = "file keyword" +description = "name of the release times file. RELEASE_TIMES and RELEASE_TIMESFILE are mutually exclusive." +removed = "6.6.1" + +[options.dry_tracking_method] +block = "options" +name = "dry_tracking_method" +type = "string" +reader = "urword" +optional = true +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." +valid = "drop stop stay" + +[options.dev_forceternary] +block = "options" +name = "dev_forceternary" +type = "keyword" +reader = "urword" +optional = false +longname = "force ternary tracking method" +description = "force use of the ternary tracking method regardless of cell type in disv grids." +mf6internal = "ifrctrn" + +[options.release_time_tolerance] +block = "options" +name = "release_time_tolerance" +type = "double precision" +reader = "urword" +optional = true +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." + +[options.release_time_frequency] +block = "options" +name = "release_time_frequency" +type = "double precision" +reader = "urword" +optional = true +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." + +[dimensions.nreleasepts] +block = "dimensions" +name = "nreleasepts" +type = "integer" +reader = "urword" +optional = false +longname = "number of particle release points" +description = "is the number of particle release points." + +[dimensions.nreleasetimes] +block = "dimensions" +name = "nreleasetimes" +type = "integer" +reader = "urword" +optional = false +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." + +[packagedata.packagedata] +block = "packagedata" +name = "packagedata" +type = "list" +shape = "(nreleasepts)" +reader = "urword" + +[packagedata.packagedata.item] +name = "packagedata" +type = "record" +block = "packagedata" +reader = "urword" + +[packagedata.packagedata.item.fields.irptno] +block = "packagedata" +name = "irptno" +type = "integer" +reader = "urword" +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." +numeric_index = "true" + +[packagedata.packagedata.item.fields.cellid] +block = "packagedata" +name = "cellid" +type = "integer" +shape = "(ncelldim)" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.xrpt] +block = "packagedata" +name = "xrpt" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.yrpt] +block = "packagedata" +name = "yrpt" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.zrpt] +block = "packagedata" +name = "zrpt" +type = "double precision" +reader = "urword" +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." + +[packagedata.packagedata.item.fields.boundname] +block = "packagedata" +name = "boundname" +type = "string" +reader = "urword" +optional = "true" +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." + +[releasetimes.releasetimes] +block = "releasetimes" +name = "releasetimes" +type = "list" +shape = "(nreleasetimes)" +reader = "urword" + +[releasetimes.releasetimes.item] +name = "releasetimes" +type = "record" +block = "releasetimes" +reader = "urword" + +[releasetimes.releasetimes.item.fields.time] +block = "releasetimes" +name = "time" +type = "double precision" +reader = "urword" +longname = "release time" +description = "real value that defines the release time with respect to the simulation start time." + +[period] +transient_block = true + +[period.perioddata] +block = "period" +name = "perioddata" +type = "list" +reader = "urword" + +[period.perioddata.item] +block = "period" +name = "releasesetting" +type = "union" +reader = "urword" +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. 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." + +[period.perioddata.item.choices.all] +block = "period" +name = "all" +type = "keyword" +reader = "urword" +description = "keyword to indicate release at the start of all time steps in the period." + +[period.perioddata.item.choices.first] +block = "period" +name = "first" +type = "keyword" +reader = "urword" +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." + +[period.perioddata.item.choices.last] +block = "period" +name = "last" +type = "keyword" +reader = "urword" +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." + +[period.perioddata.item.choices.frequency] +block = "period" +name = "frequency" +type = "integer" +reader = "urword" +description = "release at the specified time step frequency. this keyword may be used in conjunction with other releasesetting options." + +[period.perioddata.item.choices.steps] +block = "period" +name = "steps" +type = "integer" +shape = "( - * is the exchange type (GWF-GWF or GWF-GWT). - exgmnamea : - * is the name of the first model that is part of this exchange. - exgmnameb : - * is the name of the second model that is part of this exchange. gwfmodelname1 : string - * gwfmodelname1 (string) 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. + 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. gwfmodelname2 : string - * gwfmodelname2 (string) 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. + 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. auxiliary : [string] - * auxiliary (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of GWE Exchange cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of exchange - entries will be echoed to the listing file immediately after it is - read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) 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. + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of gwe + exchange cells. + print_input : keyword + keyword to indicate that the list of exchange entries will be echoed to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + 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. adv_scheme : string - * adv_scheme (string) scheme used to solve the advection term. Can be - upstream, central, or TVD. If not specified, upstream weighting is - the default weighting scheme. - cnd_xt3d_off : boolean - * cnd_xt3d_off (boolean) deactivate the xt3d method for the dispersive - flux and use the faster and less accurate approximation for this - exchange. - cnd_xt3d_rhs : boolean - * cnd_xt3d_rhs (boolean) add xt3d dispersion terms to right-hand side, - when possible, for this exchange. - filein : boolean - * filein (boolean) keyword to specify that an input filename is - expected next. - perioddata : {varname:data} or perioddata data - * Contains data for the mve package. Data can be stored in a dictionary - containing data for the mve package with variable names as keys and - package data as values. Data just for the perioddata variable is also - acceptable. See mve package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - dev_interfacemodel_on : boolean - * dev_interfacemodel_on (boolean) activates the interface model - mechanism for calculating the coefficients at (and possibly near) the - exchange. This keyword should only be used for development purposes. + scheme used to solve the advection term. can be upstream, central, or tvd. if + not specified, upstream weighting is the default weighting scheme. + cnd_xt3d_off : keyword + deactivate the xt3d method for the dispersive flux and use the faster and less + accurate approximation for this exchange. + cnd_xt3d_rhs : keyword + add xt3d dispersion terms to right-hand side, when possible, for this exchange. + perioddata : record mve6 filein mve6_filename + Contains data for the mve package. Data can be passed as a dictionary to the + mve package with variable names as keys and package data as values. Data for + the perioddata variable is also acceptable. See mve package documentation for + more information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + dev_interfacemodel_on : keyword + activates the interface model mechanism for calculating the coefficients at + (and possibly near) the exchange. this keyword should only be used for + development purposes. nexg : integer - * nexg (integer) keyword and integer value specifying the number of - GWE-GWE exchanges. - exchangedata : [cellidm1, cellidm2, ihc, cl1, cl2, hwva, aux, boundname] - * cellidm1 ((integer, ...)) 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. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - * cellidm2 ((integer, ...)) 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. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - * ihc (integer) 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. - * cl1 (double) is the distance between the center of cell 1 and the its - shared face with cell 2. - * cl2 (double) is the distance between the center of cell 2 and the its - shared face with cell 1. - * hwva (double) 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. - * aux (double) 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. - * boundname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + keyword and integer value specifying the number of gwe-gwe exchanges. + exchangedata : [list] """ - auxiliary = ListTemplateGenerator(("gwegwe", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwegwe", "options", "auxiliary")) mve_filerecord = ListTemplateGenerator(("gwegwe", "options", "mve_filerecord")) obs_filerecord = ListTemplateGenerator(("gwegwe", "options", "obs_filerecord")) exchangedata = ListTemplateGenerator(("gwegwe", "exchangedata", "exchangedata")) package_abbr = "gwegwe" _package_type = "gwegwe" dfn_file_name = "exg-gwegwe.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name gwfmodelname1", @@ -295,8 +219,8 @@ class ModflowGwegwe(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -437,7 +361,6 @@ def __init__( adv_scheme=None, cnd_xt3d_off=None, cnd_xt3d_rhs=None, - filein=None, perioddata=None, observations=None, dev_interfacemodel_on=None, @@ -447,17 +370,105 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwegwe defines a GWEGWE package. + + simulation : MFSimulation + Simulation that this package is a part of. Package is automatically + added to simulation when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + exgtype : str + The exchange type (GWF-GWF or GWF-GWT). + exgmnamea : str + The name of the first model that is part of this exchange. + exgmnameb : str + The name of the second model that is part of this exchange. + gwfmodelname1 : str + Name of first 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. + gwfmodelname2 : str + Name of second 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. + gwfmodelname1 : string + 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. + gwfmodelname2 : string + 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. + auxiliary : [string] + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of gwe + exchange cells. + print_input : keyword + keyword to indicate that the list of exchange entries will be echoed to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + 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. + adv_scheme : string + scheme used to solve the advection term. can be upstream, central, or tvd. if + not specified, upstream weighting is the default weighting scheme. + cnd_xt3d_off : keyword + deactivate the xt3d method for the dispersive flux and use the faster and less + accurate approximation for this exchange. + cnd_xt3d_rhs : keyword + add xt3d dispersion terms to right-hand side, when possible, for this exchange. + perioddata : record mve6 filein mve6_filename + Contains data for the mve package. Data can be passed as a dictionary to the + mve package with variable names as keys and package data as values. Data for + the perioddata variable is also acceptable. See mve package documentation for + more information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + dev_interfacemodel_on : keyword + activates the interface model mechanism for calculating the coefficients at + (and possibly near) the exchange. this keyword should only be used for + development purposes. + nexg : integer + keyword and integer value specifying the number of gwe-gwe exchanges. + exchangedata : [list] + + """ + super().__init__( simulation, "gwegwe", filename, pname, loading_package, **kwargs ) - # set up variables self.exgtype = exgtype - self.exgmnamea = exgmnamea - self.exgmnameb = exgmnameb - simulation.register_exchange_file(self) self.gwfmodelname1 = self.build_mfdata("gwfmodelname1", gwfmodelname1) @@ -470,7 +481,6 @@ def __init__( self.adv_scheme = self.build_mfdata("adv_scheme", adv_scheme) self.cnd_xt3d_off = self.build_mfdata("cnd_xt3d_off", cnd_xt3d_off) self.cnd_xt3d_rhs = self.build_mfdata("cnd_xt3d_rhs", cnd_xt3d_rhs) - self.filein = self.build_mfdata("filein", filein) self._mve_filerecord = self.build_mfdata("mve_filerecord", None) self._mve_package = self.build_child_package( "mve", perioddata, "perioddata", self._mve_filerecord @@ -484,4 +494,5 @@ def __init__( ) self.nexg = self.build_mfdata("nexg", nexg) self.exchangedata = self.build_mfdata("exchangedata", exchangedata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgweic.py b/flopy/mf6/modflow/mfgweic.py index 6f9ece1e1b..6a5e6f468c 100644 --- a/flopy/mf6/modflow/mfgweic.py +++ b/flopy/mf6/modflow/mfgweic.py @@ -1,41 +1,28 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGweic(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGweic(MFPackage): """ - ModflowGweic defines a ic package within a gwe6 model. + ModflowGweic defines a IC package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. - export_array_netcdf : boolean - * export_array_netcdf (boolean) keyword that specifies input griddata - arrays should be written to the model output netcdf file. - strt : [double] - * strt (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + strt : [double precision] + 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. """ @@ -43,11 +30,8 @@ class ModflowGweic(mfpackage.MFPackage): package_abbr = "gweic" _package_type = "ic" dfn_file_name = "gwe-ic.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name export_array_ascii", @@ -73,7 +57,7 @@ class ModflowGweic(mfpackage.MFPackage): "reader readarray", "layered true", "netcdf true", - "default_value 0.0", + "default 0.0", ], ] @@ -88,9 +72,40 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGweic defines a IC package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + strt : [double precision] + 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. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "ic", filename, pname, loading_package, **kwargs) - # set up variables self.export_array_ascii = self.build_mfdata( "export_array_ascii", export_array_ascii ) @@ -98,4 +113,5 @@ def __init__( "export_array_netcdf", export_array_netcdf ) self.strt = self.build_mfdata("strt", strt) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwelke.py b/flopy/mf6/modflow/mfgwelke.py index 73d9faa7f2..366963cade 100644 --- a/flopy/mf6/modflow/mfgwelke.py +++ b/flopy/mf6/modflow/mfgwelke.py @@ -1,209 +1,92 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwelke(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwelke(MFPackage): """ - ModflowGwelke defines a lke package within a gwe6 model. + ModflowGwelke defines a LKE package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. flow_package_name : string - * flow_package_name (string) 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). + 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). auxiliary : [string] - * auxiliary (string) 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. + 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. flow_package_auxiliary_name : string - * flow_package_auxiliary_name (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of lake cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of lake - information will be written to the listing file immediately after it - is read. - print_temperature : boolean - * print_temperature (boolean) keyword to indicate that the list of lake - temperature 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_TEMPERATURE is - specified, then temperature are printed for the last time step of - each stress period. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that lake flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - temperature_filerecord : [tempfile] - * tempfile (string) name of the binary output file to write temperature - information. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - packagedata : [lakeno, strt, ktf, rbthcnd, aux, boundname] - * lakeno (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * strt (double) real value that defines the starting temperature for - the lake. - * ktf (double) 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. - * rbthcnd (double) real value that defines the thickness of the lakebed - material through which conduction occurs. Must be greater than 0. - * aux (double) 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. - * boundname (string) 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. - lakeperioddata : [lakeno, laksetting] - * lakeno (integer) 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. This argument is - an index variable, which means that it should be treated as zero- - based when working with FloPy and Python. Flopy will automatically - subtract one when loading index variables and add one when writing - index variables. - * laksetting (keystring) 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. - status : [string] - * status (string) 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. - temperature : [string] - * temperature (string) 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. - rainfall : [string] - * rainfall (string) 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. - evaporation : [string] - * evaporation (string) 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. - runoff : [string] - * runoff (string) 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. - ext_inflow : [string] - * ext-inflow (string) 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. - auxiliaryrecord : [auxname, auxval] - * auxname (string) 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. - * auxval (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of lake + cells. + print_input : keyword + keyword to indicate that the list of lake information will be written to the + listing file immediately after it is read. + print_temperature : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that lake flow terms will be written to the file specified + with 'budget fileout' in output control. + temperature_filerecord : (tempfile) + * tempfile : string + name of the binary output file to write temperature information. + + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + lakeperioddata : list """ - auxiliary = ListTemplateGenerator(("gwe6", "lke", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwe6", "lke", "options", "auxiliary")) temperature_filerecord = ListTemplateGenerator( ("gwe6", "lke", "options", "temperature_filerecord") ) @@ -220,12 +103,8 @@ class ModflowGwelke(mfpackage.MFPackage): package_abbr = "gwelke" _package_type = "lke" dfn_file_name = "gwe-lke.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name flow_package_name", @@ -437,8 +316,8 @@ class ModflowGwelke(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -557,8 +436,7 @@ class ModflowGwelke(mfpackage.MFPackage): [ "block period", "name laksetting", - "type keystring status temperature rainfall evaporation runoff " - "ext-inflow auxiliaryrecord", + "type keystring status temperature rainfall evaporation runoff ext-inflow auxiliaryrecord", "shape", "tagged false", "in_record true", @@ -684,9 +562,89 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwelke defines a LKE package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + flow_package_name : string + 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). + auxiliary : [string] + 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. + flow_package_auxiliary_name : string + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of lake + cells. + print_input : keyword + keyword to indicate that the list of lake information will be written to the + listing file immediately after it is read. + print_temperature : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that lake flow terms will be written to the file specified + with 'budget fileout' in output control. + temperature_filerecord : record + budget_filerecord : record + budgetcsv_filerecord : record + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + lakeperioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "lke", filename, pname, loading_package, **kwargs) - # set up variables self.flow_package_name = self.build_mfdata( "flow_package_name", flow_package_name ) @@ -720,4 +678,5 @@ def __init__( ) self.packagedata = self.build_mfdata("packagedata", packagedata) self.lakeperioddata = self.build_mfdata("lakeperioddata", lakeperioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwemve.py b/flopy/mf6/modflow/mfgwemve.py index 1b7dc1e7a8..26caca275d 100644 --- a/flopy/mf6/modflow/mfgwemve.py +++ b/flopy/mf6/modflow/mfgwemve.py @@ -1,52 +1,40 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwemve(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwemve(MFPackage): """ - ModflowGwemve defines a mve package within a gwe6 model. + ModflowGwemve defines a MVE package. Parameters ---------- - parent_model_or_package : MFModel/MFPackage - Parent_model_or_package that this package is a part of. Package is automatically - added to parent_model_or_package when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of mover - information will be written to the listing file immediately after it - is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that lake flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + print_input : keyword + keyword to indicate that the list of mover information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that lake flow terms will be written to the file specified + with 'budget fileout' in output control. + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + """ @@ -59,11 +47,8 @@ class ModflowGwemve(mfpackage.MFPackage): package_abbr = "gwemve" _package_type = "mve" dfn_file_name = "gwe-mve.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name print_input", @@ -170,11 +155,46 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwemve defines a MVE package. + + Parameters + ---------- + parent_model_or_package + Parent_model_or_package that this package is a part of. Package is automatically + added to parent_model_or_package when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + print_input : keyword + keyword to indicate that the list of mover information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that lake flow terms will be written to the file specified + with 'budget fileout' in output control. + budget_filerecord : record + budgetcsv_filerecord : record + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__( parent_model_or_package, "mve", filename, pname, loading_package, **kwargs ) - # set up variables self.print_input = self.build_mfdata("print_input", print_input) self.print_flows = self.build_mfdata("print_flows", print_flows) self.save_flows = self.build_mfdata("save_flows", save_flows) @@ -184,10 +204,11 @@ def __init__( self.budgetcsv_filerecord = self.build_mfdata( "budgetcsv_filerecord", budgetcsv_filerecord ) + self._init_complete = True -class GwemvePackages(mfpackage.MFChildPackages): +class GwemvePackages(MFChildPackages): """ GwemvePackages is a container class for the ModflowGwemve class. @@ -200,6 +221,7 @@ class GwemvePackages(mfpackage.MFChildPackages): append_package Adds a new ModflowGwemve package to the container. See ModflowGwemve init documentation for definition of parameters. + """ package_abbr = "gwemvepackages" diff --git a/flopy/mf6/modflow/mfgwemwe.py b/flopy/mf6/modflow/mfgwemwe.py index 512caa77fb..c1fb24b4e6 100644 --- a/flopy/mf6/modflow/mfgwemwe.py +++ b/flopy/mf6/modflow/mfgwemwe.py @@ -1,188 +1,92 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwemwe(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwemwe(MFPackage): """ - ModflowGwemwe defines a mwe package within a gwe6 model. + ModflowGwemwe defines a MWE package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. flow_package_name : string - * flow_package_name (string) 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). + 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). auxiliary : [string] - * auxiliary (string) 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. + 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. flow_package_auxiliary_name : string - * flow_package_auxiliary_name (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of well cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of well - information will be written to the listing file immediately after it - is read. - print_temperature : boolean - * print_temperature (boolean) keyword to indicate that the list of well - temperature 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_TEMPERATURE is - specified, then temperature are printed for the last time step of - each stress period. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that well flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - temperature_filerecord : [tempfile] - * tempfile (string) name of the binary output file to write temperature - information. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - packagedata : [mawno, strt, ktf, fthk, aux, boundname] - * mawno (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * strt (double) real value that defines the starting temperature for - the well. - * ktf (double) 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. - * fthk (double) real value that defines the thickness of the material - through which conduction occurs. Must be greater than 0. - * aux (double) 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. - * boundname (string) 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. - mweperioddata : [mawno, mwesetting] - * mawno (integer) 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. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - * mwesetting (keystring) 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. - status : [string] - * status (string) 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. - temperature : [string] - * temperature (string) 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. - rate : [string] - * rate (string) real or character value that defines the - injection temperature - :math:`(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. - auxiliaryrecord : [auxname, auxval] - * auxname (string) 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. - * auxval (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of well + cells. + print_input : keyword + keyword to indicate that the list of well information will be written to the + listing file immediately after it is read. + print_temperature : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that well flow terms will be written to the file specified + with 'budget fileout' in output control. + temperature_filerecord : (tempfile) + * tempfile : string + name of the binary output file to write temperature information. + + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + mweperioddata : list """ - auxiliary = ListTemplateGenerator(("gwe6", "mwe", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwe6", "mwe", "options", "auxiliary")) temperature_filerecord = ListTemplateGenerator( ("gwe6", "mwe", "options", "temperature_filerecord") ) @@ -199,12 +103,8 @@ class ModflowGwemwe(mfpackage.MFPackage): package_abbr = "gwemwe" _package_type = "mwe" dfn_file_name = "gwe-mwe.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name flow_package_name", @@ -416,8 +316,8 @@ class ModflowGwemwe(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -632,9 +532,89 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwemwe defines a MWE package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + flow_package_name : string + 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). + auxiliary : [string] + 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. + flow_package_auxiliary_name : string + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of well + cells. + print_input : keyword + keyword to indicate that the list of well information will be written to the + listing file immediately after it is read. + print_temperature : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that well flow terms will be written to the file specified + with 'budget fileout' in output control. + temperature_filerecord : record + budget_filerecord : record + budgetcsv_filerecord : record + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + mweperioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "mwe", filename, pname, loading_package, **kwargs) - # set up variables self.flow_package_name = self.build_mfdata( "flow_package_name", flow_package_name ) @@ -668,4 +648,5 @@ def __init__( ) self.packagedata = self.build_mfdata("packagedata", packagedata) self.mweperioddata = self.build_mfdata("mweperioddata", mweperioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwenam.py b/flopy/mf6/modflow/mfgwenam.py index 5d290021fa..edf798b19f 100644 --- a/flopy/mf6/modflow/mfgwenam.py +++ b/flopy/mf6/modflow/mfgwenam.py @@ -1,74 +1,51 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwenam(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwenam(MFPackage): """ - ModflowGwenam defines a nam package within a gwe6 model. + ModflowGwenam defines a NAM package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. list : string - * list (string) 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". - print_input : boolean - * print_input (boolean) keyword to indicate that the list of all model - stress package information will be written to the listing file - immediately after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that all model package flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - nc_mesh2d_filerecord : [ncmesh2dfile] - * ncmesh2dfile (string) name of the netcdf ugrid layered mesh output - file. - nc_structured_filerecord : [ncstructfile] - * ncstructfile (string) name of the netcdf structured output file. - nc_filerecord : [netcdf_filename] - * netcdf_filename (string) defines a netcdf input file. - packages : [ftype, fname, pname] - * ftype (string) 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. - * fname (string) 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. - * pname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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'. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that all model package flow terms will be written to the + file specified with 'budget fileout' in output control. + nc_mesh2d_filerecord : (ncmesh2dfile) + netcdf layered mesh fileout record. + * ncmesh2dfile : string + name of the netcdf ugrid layered mesh output file. + + nc_structured_filerecord : (ncstructfile) + netcdf structured fileout record. + * ncstructfile : string + name of the netcdf structured output file. + + nc_filerecord : (netcdf_filename) + netcdf filerecord + * netcdf_filename : string + defines a netcdf input file. + + packages : list """ @@ -83,11 +60,8 @@ class ModflowGwenam(mfpackage.MFPackage): package_abbr = "gwenam" _package_type = "nam" dfn_file_name = "gwe-nam.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name list", @@ -284,9 +258,54 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwenam defines a NAM package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + list : string + 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'. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that all model package flow terms will be written to the + file specified with 'budget fileout' in output control. + nc_mesh2d_filerecord : record + netcdf layered mesh fileout record. + nc_structured_filerecord : record + netcdf structured fileout record. + nc_filerecord : record + netcdf filerecord + packages : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "nam", filename, pname, loading_package, **kwargs) - # set up variables self.list = self.build_mfdata("list", list) self.print_input = self.build_mfdata("print_input", print_input) self.print_flows = self.build_mfdata("print_flows", print_flows) @@ -299,4 +318,5 @@ def __init__( ) self.nc_filerecord = self.build_mfdata("nc_filerecord", nc_filerecord) self.packages = self.build_mfdata("packages", packages) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgweoc.py b/flopy/mf6/modflow/mfgweoc.py index b49f6206aa..2850247c39 100644 --- a/flopy/mf6/modflow/mfgweoc.py +++ b/flopy/mf6/modflow/mfgweoc.py @@ -1,94 +1,54 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGweoc(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGweoc(MFPackage): """ - ModflowGweoc defines a oc package within a gwe6 model. + ModflowGweoc defines a OC package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - temperature_filerecord : [temperaturefile] - * temperaturefile (string) name of the output file to write temperature - information. - temperatureprintrecord : [columns, width, digits, format] - * columns (integer) number of columns for writing data. - * width (integer) width for writing each number. - * digits (integer) number of digits to use for writing a number. - * format (string) write format can be EXPONENTIAL, FIXED, GENERAL, or - SCIENTIFIC. - saverecord : [rtype, ocsetting] - * rtype (string) type of information to save or print. Can be BUDGET or - TEMPERATURE. - * ocsetting (keystring) specifies the steps for which the data will be - saved. - all : [keyword] - * all (keyword) keyword to indicate save for all time steps in - period. - first : [keyword] - * first (keyword) 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. - last : [keyword] - * last (keyword) 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. - frequency : [integer] - * frequency (integer) 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. - steps : [integer] - * steps (integer) 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. - printrecord : [rtype, ocsetting] - * rtype (string) type of information to save or print. Can be BUDGET or - TEMPERATURE. - * ocsetting (keystring) specifies the steps for which the data will be - saved. - all : [keyword] - * all (keyword) keyword to indicate save for all time steps in - period. - first : [keyword] - * first (keyword) 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. - last : [keyword] - * last (keyword) 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. - frequency : [integer] - * frequency (integer) 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. - steps : [integer] - * steps (integer) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + budget_filerecord : (budgetfile) + * budgetfile : string + name of the output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + temperature_filerecord : (temperaturefile) + * temperaturefile : string + name of the output file to write temperature information. + + temperatureprintrecord : (temperature, print_format) + * temperature : keyword + keyword to specify that record corresponds to temperature. + * print_format : keyword + keyword to specify format for printing to the listing file. + + saverecord : (save, rtype, ocsetting) + * save : keyword + keyword to indicate that information will be saved this stress period. + * rtype : string + type of information to save or print. Can be BUDGET or TEMPERATURE. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + + printrecord : (print, rtype, ocsetting) + * print : keyword + keyword to indicate that information will be printed this stress period. + * rtype : string + type of information to save or print. Can be BUDGET or TEMPERATURE. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + """ @@ -109,11 +69,8 @@ class ModflowGweoc(mfpackage.MFPackage): package_abbr = "gweoc" _package_type = "oc" dfn_file_name = "gwe-oc.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name budget_filerecord", @@ -409,9 +366,55 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGweoc defines a OC package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + budget_filerecord : record + budgetcsv_filerecord : record + temperature_filerecord : record + temperatureprintrecord : (temperature, print_format) + * temperature : keyword + keyword to specify that record corresponds to temperature. + * print_format : keyword + keyword to specify format for printing to the listing file. + + saverecord : (save, rtype, ocsetting) + * save : keyword + keyword to indicate that information will be saved this stress period. + * rtype : string + type of information to save or print. Can be BUDGET or TEMPERATURE. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + + printrecord : (print, rtype, ocsetting) + * print : keyword + keyword to indicate that information will be printed this stress period. + * rtype : string + type of information to save or print. Can be BUDGET or TEMPERATURE. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "oc", filename, pname, loading_package, **kwargs) - # set up variables self.budget_filerecord = self.build_mfdata( "budget_filerecord", budget_filerecord ) @@ -426,4 +429,5 @@ def __init__( ) self.saverecord = self.build_mfdata("saverecord", saverecord) self.printrecord = self.build_mfdata("printrecord", printrecord) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwesfe.py b/flopy/mf6/modflow/mfgwesfe.py index ad0f3a6b32..29ea276859 100644 --- a/flopy/mf6/modflow/mfgwesfe.py +++ b/flopy/mf6/modflow/mfgwesfe.py @@ -1,214 +1,92 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwesfe(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwesfe(MFPackage): """ - ModflowGwesfe defines a sfe package within a gwe6 model. + ModflowGwesfe defines a SFE package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. flow_package_name : string - * flow_package_name (string) 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). + 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). auxiliary : [string] - * auxiliary (string) 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. + 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. flow_package_auxiliary_name : string - * flow_package_auxiliary_name (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of reach cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of reach - information will be written to the listing file immediately after it - is read. - print_temperature : boolean - * print_temperature (boolean) keyword to indicate that the list of - reach temperatures 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_TEMPERATURE - is specified, then temperatures are printed for the last time step of - each stress period. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that reach flow terms will - be written to the file specified with "BUDGET FILEOUT" in Output - Control. - temperature_filerecord : [tempfile] - * tempfile (string) name of the binary output file to write temperature - information. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - packagedata : [rno, strt, ktf, rbthcnd, aux, boundname] - * rno (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - * strt (double) real value that defines the starting temperature for - the reach. - * ktf (double) 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. - * rbthcnd (double) real value that defines the thickness of the - streambed material through which conduction occurs. Must be greater - than 0. - * aux (double) 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. - * boundname (string) 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. - reachperioddata : [rno, reachsetting] - * rno (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - * reachsetting (keystring) 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. - status : [string] - * status (string) 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. - temperature : [string] - * temperature (string) 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. - rainfall : [string] - * rainfall (string) real or character value that defines the - rainfall temperature - :math:`(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. - evaporation : [string] - * evaporation (string) 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. - runoff : [string] - * runoff (string) real or character value that defines the - temperature of runoff - :math:`(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. - inflow : [string] - * inflow (string) real or character value that defines the - temperature of inflow - :math:`(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. - auxiliaryrecord : [auxname, auxval] - * auxname (string) 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. - * auxval (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of reach + cells. + print_input : keyword + keyword to indicate that the list of reach information will be written to the + listing file immediately after it is read. + print_temperature : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that reach flow terms will be written to the file specified + with 'budget fileout' in output control. + temperature_filerecord : (tempfile) + * tempfile : string + name of the binary output file to write temperature information. + + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + reachperioddata : list """ - auxiliary = ListTemplateGenerator(("gwe6", "sfe", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwe6", "sfe", "options", "auxiliary")) temperature_filerecord = ListTemplateGenerator( ("gwe6", "sfe", "options", "temperature_filerecord") ) @@ -227,12 +105,8 @@ class ModflowGwesfe(mfpackage.MFPackage): package_abbr = "gwesfe" _package_type = "sfe" dfn_file_name = "gwe-sfe.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name flow_package_name", @@ -444,8 +318,8 @@ class ModflowGwesfe(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -564,8 +438,7 @@ class ModflowGwesfe(mfpackage.MFPackage): [ "block period", "name reachsetting", - "type keystring status temperature rainfall evaporation runoff " - "inflow auxiliaryrecord", + "type keystring status temperature rainfall evaporation runoff inflow auxiliaryrecord", "shape", "tagged false", "in_record true", @@ -691,9 +564,89 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwesfe defines a SFE package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + flow_package_name : string + 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). + auxiliary : [string] + 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. + flow_package_auxiliary_name : string + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of reach + cells. + print_input : keyword + keyword to indicate that the list of reach information will be written to the + listing file immediately after it is read. + print_temperature : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that reach flow terms will be written to the file specified + with 'budget fileout' in output control. + temperature_filerecord : record + budget_filerecord : record + budgetcsv_filerecord : record + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + reachperioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "sfe", filename, pname, loading_package, **kwargs) - # set up variables self.flow_package_name = self.build_mfdata( "flow_package_name", flow_package_name ) @@ -727,4 +680,5 @@ def __init__( ) self.packagedata = self.build_mfdata("packagedata", packagedata) self.reachperioddata = self.build_mfdata("reachperioddata", reachperioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwessm.py b/flopy/mf6/modflow/mfgwessm.py index e5e77a006c..99c2b4107f 100644 --- a/flopy/mf6/modflow/mfgwessm.py +++ b/flopy/mf6/modflow/mfgwessm.py @@ -1,82 +1,29 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwessm(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwessm(MFPackage): """ - ModflowGwessm defines a ssm package within a gwe6 model. + ModflowGwessm defines a SSM package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that SSM flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - sources : [pname, srctype, auxname] - * pname (string) 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. - * srctype (string) 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. - * auxname (string) 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. - fileinput : [pname, spc6_filename] - * pname (string) 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. - * spc6_filename (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that ssm flow terms will be written to the file specified + with 'budget fileout' in output control. + sources : list + fileinput : list """ @@ -85,11 +32,8 @@ class ModflowGwessm(mfpackage.MFPackage): package_abbr = "gwessm" _package_type = "ssm" dfn_file_name = "gwe-ssm.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name print_flows", @@ -205,11 +149,44 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwessm defines a SSM package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that ssm flow terms will be written to the file specified + with 'budget fileout' in output control. + sources : list + fileinput : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "ssm", filename, pname, loading_package, **kwargs) - # set up variables self.print_flows = self.build_mfdata("print_flows", print_flows) self.save_flows = self.build_mfdata("save_flows", save_flows) self.sources = self.build_mfdata("sources", sources) self.fileinput = self.build_mfdata("fileinput", fileinput) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgweuze.py b/flopy/mf6/modflow/mfgweuze.py index eee8727fdd..b3b7df6be5 100644 --- a/flopy/mf6/modflow/mfgweuze.py +++ b/flopy/mf6/modflow/mfgweuze.py @@ -1,191 +1,92 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGweuze(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGweuze(MFPackage): """ - ModflowGweuze defines a uze package within a gwe6 model. + ModflowGweuze defines a UZE package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. flow_package_name : string - * flow_package_name (string) 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). + 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). auxiliary : [string] - * auxiliary (string) 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. + 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. flow_package_auxiliary_name : string - * flow_package_auxiliary_name (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of unsaturated zone flow cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of - unsaturated zone flow information will be written to the listing file - immediately after it is read. - print_temperature : boolean - * print_temperature (boolean) keyword to indicate that the list of UZF - cell temperatures 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_TEMPERATURE - is specified, then temperatures are printed for the last time step of - each stress period. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that unsaturated zone flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - temperature_filerecord : [tempfile] - * tempfile (string) name of the binary output file to write temperature - information. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - packagedata : [uzfno, strt, aux, boundname] - * uzfno (integer) 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. This argument is an index variable, which - means that it should be treated as zero-based when working with FloPy - and Python. Flopy will automatically subtract one when loading index - variables and add one when writing index variables. - * strt (double) real value that defines the starting temperature for - the unsaturated zone flow cell. - * aux (double) 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. - * boundname (string) 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. - uzeperioddata : [uzfno, uzesetting] - * uzfno (integer) 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. This argument - is an index variable, which means that it should be treated as zero- - based when working with FloPy and Python. Flopy will automatically - subtract one when loading index variables and add one when writing - index variables. - * uzesetting (keystring) 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. - status : [string] - * status (string) 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. - temperature : [string] - * temperature (string) 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. - infiltration : [string] - * infiltration (string) real or character value that defines - the temperature of the infiltration - :math:`(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. - uzet : [string] - * uzet (string) 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. - auxiliaryrecord : [auxname, auxval] - * auxname (string) 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. - * auxval (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + unsaturated zone flow cells. + print_input : keyword + keyword to indicate that the list of unsaturated zone flow information will be + written to the listing file immediately after it is read. + print_temperature : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that unsaturated zone flow terms will be written to the + file specified with 'budget fileout' in output control. + temperature_filerecord : (tempfile) + * tempfile : string + name of the binary output file to write temperature information. + + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + uzeperioddata : list """ - auxiliary = ListTemplateGenerator(("gwe6", "uze", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwe6", "uze", "options", "auxiliary")) temperature_filerecord = ListTemplateGenerator( ("gwe6", "uze", "options", "temperature_filerecord") ) @@ -202,12 +103,8 @@ class ModflowGweuze(mfpackage.MFPackage): package_abbr = "gweuze" _package_type = "uze" dfn_file_name = "gwe-uze.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name flow_package_name", @@ -419,8 +316,8 @@ class ModflowGweuze(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -627,9 +524,89 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGweuze defines a UZE package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + flow_package_name : string + 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). + auxiliary : [string] + 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. + flow_package_auxiliary_name : string + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + unsaturated zone flow cells. + print_input : keyword + keyword to indicate that the list of unsaturated zone flow information will be + written to the listing file immediately after it is read. + print_temperature : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that unsaturated zone flow terms will be written to the + file specified with 'budget fileout' in output control. + temperature_filerecord : record + budget_filerecord : record + budgetcsv_filerecord : record + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + uzeperioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "uze", filename, pname, loading_package, **kwargs) - # set up variables self.flow_package_name = self.build_mfdata( "flow_package_name", flow_package_name ) @@ -663,4 +640,5 @@ def __init__( ) self.packagedata = self.build_mfdata("packagedata", packagedata) self.uzeperioddata = self.build_mfdata("uzeperioddata", uzeperioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwf.py b/flopy/mf6/modflow/mfgwf.py index bf1d74cef2..98a6f91187 100644 --- a/flopy/mf6/modflow/mfgwf.py +++ b/flopy/mf6/modflow/mfgwf.py @@ -1,78 +1,56 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfmodel -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwf(mfmodel.MFModel): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfmodel import MFModel + + +class ModflowGwf(MFModel): """ - Modflowgwf defines a gwf model + ModflowGwf defines a GWF model. Parameters ---------- - modelname : string - name of the model - model_nam_file : string - relative path to the model name file from model working folder - version : string - version of modflow - exe_name : string - model executable name - model_ws : string - model working folder path - sim : MFSimulation - Simulation that this model is a part of. Model is automatically - added to simulation when it is initialized. list : string - * list (string) 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". - print_input : boolean - * print_input (boolean) keyword to indicate that the list of all model - stress package information will be written to the listing file - immediately after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that all model package flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - newtonoptions : [under_relaxation] - * under_relaxation (string) 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. - nc_mesh2d_filerecord : [ncmesh2dfile] - * ncmesh2dfile (string) name of the netcdf ugrid layered mesh output - file. - nc_structured_filerecord : [ncstructfile] - * ncstructfile (string) name of the netcdf structured output file. - nc_filerecord : [netcdf_filename] - * netcdf_filename (string) defines a netcdf input file. - packages : [ftype, fname, pname] - * ftype (string) 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. - * fname (string) 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. - * pname (string) 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. + 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'. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that all model package flow terms will be written to the + file specified with 'budget fileout' in output control. + newtonoptions : (newton, under_relaxation) + none + * newton : keyword + 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. + * under_relaxation : keyword + 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. + + nc_mesh2d_filerecord : record + netcdf layered mesh fileout record. + nc_structured_filerecord : record + netcdf structured fileout record. + nc_filerecord : record + netcdf filerecord + packages : list + Methods ------- @@ -102,6 +80,65 @@ def __init__( nc_filerecord=None, **kwargs, ): + """ + ModflowGwf defines a GWF model. + + Parameters + ---------- + modelname : string + name of the model + model_nam_file : string + relative path to the model name file from model working folder + version : string + version of modflow + exe_name : string + model executable name + model_ws : string + model working folder path + sim : MFSimulation + Simulation that this model is a part of. Model is automatically + added to simulation when it is initialized. + + list : string + 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'. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that all model package flow terms will be written to the + file specified with 'budget fileout' in output control. + newtonoptions : (newton, under_relaxation) + none + * newton : keyword + 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. + * under_relaxation : keyword + 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. + + nc_mesh2d_filerecord : record + netcdf layered mesh fileout record. + nc_structured_filerecord : record + netcdf structured fileout record. + nc_filerecord : record + netcdf filerecord + packages : list + + """ + super().__init__( simulation, model_type="gwf6", @@ -114,21 +151,20 @@ def __init__( ) self.name_file.list.set_data(list) - self.name_file.print_input.set_data(print_input) - self.name_file.print_flows.set_data(print_flows) - self.name_file.save_flows.set_data(save_flows) - self.name_file.newtonoptions.set_data(newtonoptions) - self.name_file.nc_mesh2d_filerecord.set_data(nc_mesh2d_filerecord) - self.name_file.nc_structured_filerecord.set_data(nc_structured_filerecord) - self.name_file.nc_filerecord.set_data(nc_filerecord) - self.list = self.name_file.list + self.name_file.print_input.set_data(print_input) self.print_input = self.name_file.print_input + self.name_file.print_flows.set_data(print_flows) self.print_flows = self.name_file.print_flows + self.name_file.save_flows.set_data(save_flows) self.save_flows = self.name_file.save_flows + self.name_file.newtonoptions.set_data(newtonoptions) self.newtonoptions = self.name_file.newtonoptions + self.name_file.nc_mesh2d_filerecord.set_data(nc_mesh2d_filerecord) self.nc_mesh2d_filerecord = self.name_file.nc_mesh2d_filerecord + self.name_file.nc_structured_filerecord.set_data(nc_structured_filerecord) self.nc_structured_filerecord = self.name_file.nc_structured_filerecord + self.name_file.nc_filerecord.set_data(nc_filerecord) self.nc_filerecord = self.name_file.nc_filerecord @classmethod @@ -141,10 +177,10 @@ def load( version="mf6", exe_name="mf6", strict=True, - model_rel_path=".", + model_rel_path=curdir, load_only=None, ): - return mfmodel.MFModel.load_base( + return MFModel.load_base( cls, simulation, structure, diff --git a/flopy/mf6/modflow/mfgwfapi.py b/flopy/mf6/modflow/mfgwfapi.py index 5390f2a918..4c111fb80b 100644 --- a/flopy/mf6/modflow/mfgwfapi.py +++ b/flopy/mf6/modflow/mfgwfapi.py @@ -1,62 +1,46 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfapi(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfapi(MFPackage): """ - ModflowGwfapi defines a api package within a gwf6 model. + ModflowGwfapi defines a API package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of api boundary cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of api - boundary information will be written to the listing file immediately - after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that api boundary flow terms - will be written to the file specified with "BUDGET FILEOUT" in Output - Control. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - mover : boolean - * mover (boolean) 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of api + boundary cells. + print_input : keyword + keyword to indicate that the list of api boundary information will be written + to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that api boundary flow terms will be written to the file + specified with 'budget fileout' in output control. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. maxbound : integer - * maxbound (integer) integer value specifying the maximum number of api - boundary cells that will be specified for use during any stress - period. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the maximum number of api boundary cells that will be + specified for use during any stress period. """ @@ -64,11 +48,8 @@ class ModflowGwfapi(mfpackage.MFPackage): package_abbr = "gwfapi" _package_type = "api" dfn_file_name = "gwf-api.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name boundnames", @@ -107,8 +88,8 @@ class ModflowGwfapi(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -172,9 +153,58 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfapi defines a API package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of api + boundary cells. + print_input : keyword + keyword to indicate that the list of api boundary information will be written + to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that api boundary flow terms will be written to the file + specified with 'budget fileout' in output control. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. + maxbound : integer + integer value specifying the maximum number of api boundary cells that will be + specified for use during any stress period. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "api", filename, pname, loading_package, **kwargs) - # set up variables self.boundnames = self.build_mfdata("boundnames", boundnames) self.print_input = self.build_mfdata("print_input", print_input) self.print_flows = self.build_mfdata("print_flows", print_flows) @@ -185,4 +215,5 @@ def __init__( ) self.mover = self.build_mfdata("mover", mover) self.maxbound = self.build_mfdata("maxbound", maxbound) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfbuy.py b/flopy/mf6/modflow/mfgwfbuy.py index d412282c0c..1bb0453885 100644 --- a/flopy/mf6/modflow/mfgwfbuy.py +++ b/flopy/mf6/modflow/mfgwfbuy.py @@ -1,86 +1,40 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfbuy(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfbuy(MFPackage): """ - ModflowGwfbuy defines a buy package within a gwf6 model. + ModflowGwfbuy defines a BUY package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - hhformulation_rhs : boolean - * hhformulation_rhs (boolean) 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. - denseref : double - * denseref (double) fluid reference density used in the equation of - state. This value is set to 1000. if not specified as an option. - density_filerecord : [densityfile] - * densityfile (string) 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. - dev_efh_formulation : boolean - * dev_efh_formulation (boolean) 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. + hhformulation_rhs : keyword + 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. + denseref : double precision + fluid reference density used in the equation of state. this value is set to + 1000. if not specified as an option. + density_filerecord : (densityfile) + * densityfile : string + 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. + + dev_efh_formulation : keyword + 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. nrhospecies : integer - * nrhospecies (integer) number of species used in density equation of - state. This value must be one or greater if the BUY package is - activated. - packagedata : [irhospec, drhodc, crhoref, modelname, auxspeciesname] - * irhospec (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - * drhodc (double) real value that defines the slope of the density- - concentration line for this species used in the density equation of - state. - * crhoref (double) real value that defines the reference concentration - value used for this species in the density equation of state. - * modelname (string) name of GWT 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 model that - corresponds to this GWF model. - * auxspeciesname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + number of species used in density equation of state. this value must be one or + greater if the buy package is activated. + packagedata : [list] """ @@ -91,11 +45,8 @@ class ModflowGwfbuy(mfpackage.MFPackage): package_abbr = "gwfbuy" _package_type = "buy" dfn_file_name = "gwf-buy.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name hhformulation_rhs", @@ -109,7 +60,7 @@ class ModflowGwfbuy(mfpackage.MFPackage): "type double precision", "reader urword", "optional true", - "default_value 1000.", + "default 1000.", ], [ "block options", @@ -234,9 +185,46 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfbuy defines a BUY package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + hhformulation_rhs : keyword + 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. + denseref : double precision + fluid reference density used in the equation of state. this value is set to + 1000. if not specified as an option. + density_filerecord : record + dev_efh_formulation : keyword + 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. + nrhospecies : integer + number of species used in density equation of state. this value must be one or + greater if the buy package is activated. + packagedata : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "buy", filename, pname, loading_package, **kwargs) - # set up variables self.hhformulation_rhs = self.build_mfdata( "hhformulation_rhs", hhformulation_rhs ) @@ -249,4 +237,5 @@ def __init__( ) self.nrhospecies = self.build_mfdata("nrhospecies", nrhospecies) self.packagedata = self.build_mfdata("packagedata", packagedata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfchd.py b/flopy/mf6/modflow/mfgwfchd.py index 60b21b2c61..4f9c2c8ca3 100644 --- a/flopy/mf6/modflow/mfgwfchd.py +++ b/flopy/mf6/modflow/mfgwfchd.py @@ -1,110 +1,66 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfchd(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfchd(MFPackage): """ - ModflowGwfchd defines a chd package within a gwf6 model. + ModflowGwfchd defines a CHD package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. auxiliary : [string] - * auxiliary (string) 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. + 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. auxmultname : string - * auxmultname (string) name of auxiliary variable to be used as - multiplier of CHD head value. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of constant-head cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of constant- - head information will be written to the listing file immediately - after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that constant-head flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - dev_no_newton : boolean - * dev_no_newton (boolean) turn off Newton for unconfined cells + name of auxiliary variable to be used as multiplier of chd head value. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + constant-head cells. + print_input : keyword + keyword to indicate that the list of constant-head information will be written + to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that constant-head flow terms will be written to the file + specified with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + dev_no_newton : keyword + turn off newton for unconfined cells maxbound : integer - * maxbound (integer) integer value specifying the maximum number of - constant-head cells that will be specified for use during any stress - period. - stress_period_data : [cellid, head, aux, boundname] - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * head (double) 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. - * aux (double) 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. - * boundname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the maximum number of constant-head cells that will be + specified for use during any stress period. + stress_period_data : [list] """ - auxiliary = ListTemplateGenerator(("gwf6", "chd", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwf6", "chd", "options", "auxiliary")) ts_filerecord = ListTemplateGenerator(("gwf6", "chd", "options", "ts_filerecord")) obs_filerecord = ListTemplateGenerator(("gwf6", "chd", "options", "obs_filerecord")) stress_period_data = ListTemplateGenerator( @@ -113,7 +69,6 @@ class ModflowGwfchd(mfpackage.MFPackage): package_abbr = "gwfchd" _package_type = "chd" dfn_file_name = "gwf-chd.dfn" - dfn = [ ["header", "multi-package", "package-type stress-package"], [ @@ -215,8 +170,8 @@ class ModflowGwfchd(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -335,9 +290,74 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfchd defines a CHD package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + auxiliary : [string] + 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. + auxmultname : string + name of auxiliary variable to be used as multiplier of chd head value. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + constant-head cells. + print_input : keyword + keyword to indicate that the list of constant-head information will be written + to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that constant-head flow terms will be written to the file + specified with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + dev_no_newton : keyword + turn off newton for unconfined cells + maxbound : integer + integer value specifying the maximum number of constant-head cells that will be + specified for use during any stress period. + stress_period_data : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "chd", filename, pname, loading_package, **kwargs) - # set up variables self.auxiliary = self.build_mfdata("auxiliary", auxiliary) self.auxmultname = self.build_mfdata("auxmultname", auxmultname) self.boundnames = self.build_mfdata("boundnames", boundnames) @@ -357,4 +377,5 @@ def __init__( self.stress_period_data = self.build_mfdata( "stress_period_data", stress_period_data ) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfcsub.py b/flopy/mf6/modflow/mfgwfcsub.py index 13fc87de55..f2fa7481e9 100644 --- a/flopy/mf6/modflow/mfgwfcsub.py +++ b/flopy/mf6/modflow/mfgwfcsub.py @@ -1,271 +1,171 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfcsub(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfcsub(MFPackage): """ - ModflowGwfcsub defines a csub package within a gwf6 model. + ModflowGwfcsub defines a CSUB package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of CSUB cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of CSUB - information will be written to the listing file immediately after it - is read. - save_flows : boolean - * save_flows (boolean) keyword to indicate that cell-by-cell flow terms - will be written to the file specified with "BUDGET SAVE FILE" in - Output Control. - gammaw : double - * gammaw (double) unit weight of water. For freshwater, GAMMAW is - 9806.65 Newtons/cubic meters or 62.48 lb/cubic foot in SI and English - units, respectively. By default, GAMMAW is 9806.65 Newtons/cubic - meters. - beta : double - * beta (double) compressibility of water. Typical values of BETA are - 4.6512e-10 1/Pa or 2.2270e-8 lb/square foot in SI and English units, - respectively. By default, BETA is 4.6512e-10 1/Pa. - head_based : boolean - * head_based (boolean) keyword to indicate the head-based formulation - will be used to simulate coarse-grained aquifer materials and no- - delay and delay interbeds. Specifying HEAD_BASED also specifies the - INITIAL_PRECONSOLIDATION_HEAD option. - initial_preconsolidation_head : boolean - * initial_preconsolidation_head (boolean) 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of csub + cells. + print_input : keyword + keyword to indicate that the list of csub information will be written to the + listing file immediately after it is read. + save_flows : keyword + keyword to indicate that cell-by-cell flow terms will be written to the file + specified with 'budget save file' in output control. + gammaw : double precision + unit weight of water. for freshwater, gammaw is 9806.65 newtons/cubic meters or + 62.48 lb/cubic foot in si and english units, respectively. by default, gammaw + is 9806.65 newtons/cubic meters. + beta : double precision + compressibility of water. typical values of beta are 4.6512e-10 1/pa or + 2.2270e-8 lb/square foot in si and english units, respectively. by default, + beta is 4.6512e-10 1/pa. + head_based : keyword + keyword to indicate the head-based formulation will be used to simulate coarse- + grained aquifer materials and no-delay and delay interbeds. specifying + head_based also specifies the initial_preconsolidation_head option. + initial_preconsolidation_head : keyword + keyword to indicate that preconsolidation heads will be specified for no-delay + and delay interbeds in the packagedata block. if the + specified_initial_interbed_state option is specified in the options block, + user-specified preconsolidation heads in the packagedata block are absolute + values. otherwise, user-specified preconsolidation heads in the packagedata + block are relative to steady-state or initial heads. ndelaycells : integer - * ndelaycells (integer) number of nodes used to discretize delay - interbeds. If not specified, then a default value of 19 is assigned. - compression_indices : boolean - * compression_indices (boolean) keyword to indicate that the - recompression (CR) and compression (CC) indices are specified instead - of the elastic specific storage (SSE) and inelastic specific storage - (SSV) coefficients. If not specified, then elastic specific storage - (SSE) and inelastic specific storage (SSV) coefficients must be - specified. - update_material_properties : boolean - * update_material_properties (boolean) keyword to indicate that the - thickness and void ratio of coarse-grained and interbed sediments - (delay and no-delay) will vary during the simulation. If not - specified, the thickness and void ratio of coarse-grained and - interbed sediments will not vary during the simulation. - cell_fraction : boolean - * cell_fraction (boolean) keyword to indicate that the thickness of - interbeds will be specified in terms of the fraction of cell - thickness. If not specified, interbed thicknness must be specified. - specified_initial_interbed_state : boolean - * specified_initial_interbed_state (boolean) keyword to indicate that - absolute preconsolidation stresses (heads) and delay bed heads will - be specified for interbeds defined in the PACKAGEDATA block. The - SPECIFIED_INITIAL_INTERBED_STATE option is equivalent to specifying - the SPECIFIED_INITIAL_PRECONSOLITATION_STRESS and - SPECIFIED_INITIAL_DELAY_HEAD. If SPECIFIED_INITIAL_INTERBED_STATE is - not specified then preconsolidation stress (head) and delay bed head - values specified in the PACKAGEDATA block are relative to simulated - values of the first stress period if steady-state or initial stresses - and GWF heads if the first stress period is transient. - specified_initial_preconsolidation_stress : boolean - * specified_initial_preconsolidation_stress (boolean) keyword to - indicate that absolute preconsolidation stresses (heads) will be - specified for interbeds defined in the PACKAGEDATA block. If - SPECIFIED_INITIAL_PRECONSOLITATION_STRESS and - SPECIFIED_INITIAL_INTERBED_STATE are not specified then - preconsolidation stress (head) values specified in the PACKAGEDATA - block are relative to simulated values if the first stress period is - steady-state or initial stresses (heads) if the first stress period - is transient. - specified_initial_delay_head : boolean - * specified_initial_delay_head (boolean) keyword to indicate that - absolute initial delay bed head will be specified for interbeds - defined in the PACKAGEDATA block. If SPECIFIED_INITIAL_DELAY_HEAD and - SPECIFIED_INITIAL_INTERBED_STATE are not specified then delay bed - head values specified in the PACKAGEDATA block are relative to - simulated values if the first stress period is steady-state or - initial GWF heads if the first stress period is transient. - effective_stress_lag : boolean - * effective_stress_lag (boolean) keyword to indicate the effective - stress from the previous time step will be used to calculate specific - storage values. This option can 1) help with convergence in models - with thin cells and water table elevations close to land surface; 2) - is identical to the approach used in the SUBWT package for - MODFLOW-2005; and 3) is only used if the effective-stress formulation - is being used. By default, current effective stress values are used - to calculate specific storage values. - strainib_filerecord : [interbedstrain_filename] - * interbedstrain_filename (string) name of the comma-separated-values - output file to write final interbed strain information. - straincg_filerecord : [coarsestrain_filename] - * coarsestrain_filename (string) name of the comma-separated-values - output file to write final coarse-grained material strain - information. - compaction_filerecord : [compaction_filename] - * compaction_filename (string) name of the binary output file to write - compaction information. - compaction_elastic_filerecord : [elastic_compaction_filename] - * elastic_compaction_filename (string) name of the binary output file - to write elastic interbed compaction information. - compaction_inelastic_filerecord : [inelastic_compaction_filename] - * inelastic_compaction_filename (string) name of the binary output file - to write inelastic interbed compaction information. - compaction_interbed_filerecord : [interbed_compaction_filename] - * interbed_compaction_filename (string) name of the binary output file - to write interbed compaction information. - compaction_coarse_filerecord : [coarse_compaction_filename] - * coarse_compaction_filename (string) name of the binary output file to - write elastic coarse-grained material compaction information. - zdisplacement_filerecord : [zdisplacement_filename] - * zdisplacement_filename (string) name of the binary output file to - write z-displacement information. - package_convergence_filerecord : [package_convergence_filename] - * package_convergence_filename (string) name of the comma spaced values - output file to write package convergence information. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. + number of nodes used to discretize delay interbeds. if not specified, then a + default value of 19 is assigned. + compression_indices : keyword + keyword to indicate that the recompression (cr) and compression (cc) indices + are specified instead of the elastic specific storage (sse) and inelastic + specific storage (ssv) coefficients. if not specified, then elastic specific + storage (sse) and inelastic specific storage (ssv) coefficients must be + specified. + update_material_properties : keyword + keyword to indicate that the thickness and void ratio of coarse-grained and + interbed sediments (delay and no-delay) will vary during the simulation. if not + specified, the thickness and void ratio of coarse-grained and interbed + sediments will not vary during the simulation. + cell_fraction : keyword + keyword to indicate that the thickness of interbeds will be specified in terms + of the fraction of cell thickness. if not specified, interbed thicknness must + be specified. + specified_initial_interbed_state : keyword + keyword to indicate that absolute preconsolidation stresses (heads) and delay + bed heads will be specified for interbeds defined in the packagedata block. the + specified_initial_interbed_state option is equivalent to specifying the + specified_initial_preconsolitation_stress and specified_initial_delay_head. if + specified_initial_interbed_state is not specified then preconsolidation stress + (head) and delay bed head values specified in the packagedata block are + relative to simulated values of the first stress period if steady-state or + initial stresses and gwf heads if the first stress period is transient. + specified_initial_preconsolidation_stress : keyword + keyword to indicate that absolute preconsolidation stresses (heads) will be + specified for interbeds defined in the packagedata block. if + specified_initial_preconsolitation_stress and specified_initial_interbed_state + are not specified then preconsolidation stress (head) values specified in the + packagedata block are relative to simulated values if the first stress period + is steady-state or initial stresses (heads) if the first stress period is + transient. + specified_initial_delay_head : keyword + keyword to indicate that absolute initial delay bed head will be specified for + interbeds defined in the packagedata block. if specified_initial_delay_head and + specified_initial_interbed_state are not specified then delay bed head values + specified in the packagedata block are relative to simulated values if the + first stress period is steady-state or initial gwf heads if the first stress + period is transient. + effective_stress_lag : keyword + keyword to indicate the effective stress from the previous time step will be + used to calculate specific storage values. this option can 1) help with + convergence in models with thin cells and water table elevations close to land + surface; 2) is identical to the approach used in the subwt package for + modflow-2005; and 3) is only used if the effective-stress formulation is being + used. by default, current effective stress values are used to calculate + specific storage values. + strainib_filerecord : (interbedstrain_filename) + * interbedstrain_filename : string + name of the comma-separated-values output file to write final interbed strain + information. + + straincg_filerecord : (coarsestrain_filename) + * coarsestrain_filename : string + name of the comma-separated-values output file to write final coarse-grained + material strain information. + + compaction_filerecord : (compaction_filename) + * compaction_filename : string + name of the binary output file to write compaction information. + + compaction_elastic_filerecord : (elastic_compaction_filename) + * elastic_compaction_filename : string + name of the binary output file to write elastic interbed compaction + information. + + compaction_inelastic_filerecord : (inelastic_compaction_filename) + * inelastic_compaction_filename : string + name of the binary output file to write inelastic interbed compaction + information. + + compaction_interbed_filerecord : (interbed_compaction_filename) + * interbed_compaction_filename : string + name of the binary output file to write interbed compaction information. + + compaction_coarse_filerecord : (coarse_compaction_filename) + * coarse_compaction_filename : string + name of the binary output file to write elastic coarse-grained material + compaction information. + + zdisplacement_filerecord : (zdisplacement_filename) + * zdisplacement_filename : string + name of the binary output file to write z-displacement information. + + package_convergence_filerecord : (package_convergence_filename) + * package_convergence_filename : string + name of the comma spaced values output file to write package convergence + information. + + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. ninterbeds : integer - * ninterbeds (integer) is the number of CSUB interbed systems. More - than 1 CSUB interbed systems can be assigned to a GWF cell; however, - only 1 GWF cell can be assigned to a single CSUB interbed system. + is the number of csub interbed systems. more than 1 csub interbed systems can + be assigned to a gwf cell; however, only 1 gwf cell can be assigned to a single + csub interbed system. maxsig0 : integer - * maxsig0 (integer) is the maximum number of cells that can have a - specified stress offset. More than 1 stress offset can be assigned to - a GWF cell. By default, MAXSIG0 is 0. - cg_ske_cr : [double] - * cg_ske_cr (double) is the initial elastic coarse-grained material - specific storage or recompression index. The recompression index is - specified if COMPRESSION_INDICES is specified in the OPTIONS block. - Specified or calculated elastic coarse-grained material specific - storage values are not adjusted from initial values if HEAD_BASED is - specified in the OPTIONS block. - cg_theta : [double] - * cg_theta (double) is the initial porosity of coarse-grained - materials. - sgm : [double] - * sgm (double) is the specific gravity of moist or unsaturated - sediments. If not specified, then a default value of 1.7 is assigned. - sgs : [double] - * sgs (double) is the specific gravity of saturated sediments. If not - specified, then a default value of 2.0 is assigned. - packagedata : [icsubno, cellid, cdelay, pcs0, thick_frac, rnb, ssv_cc, - sse_cr, theta, kv, h0, boundname] - * icsubno (integer) 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. This argument is an index variable, which means that it - should be treated as zero-based when working with FloPy and Python. - Flopy will automatically subtract one when loading index variables - and add one when writing index variables. - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * cdelay (string) 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. - * pcs0 (double) 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. - * thick_frac (double) 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. - * rnb (double) 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. - * ssv_cc (double) 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. - * sse_cr (double) 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. - * theta (double) is the initial porosity of the interbed. - * kv (double) 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. - * h0 (double) 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. - * boundname (string) 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. - stress_period_data : [cellid, sig0] - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * sig0 (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + is the maximum number of cells that can have a specified stress offset. more + than 1 stress offset can be assigned to a gwf cell. by default, maxsig0 is 0. + cg_ske_cr : [double precision] + is the initial elastic coarse-grained material specific storage or + recompression index. the recompression index is specified if + compression_indices is specified in the options block. specified or calculated + elastic coarse-grained material specific storage values are not adjusted from + initial values if head_based is specified in the options block. + cg_theta : [double precision] + is the initial porosity of coarse-grained materials. + sgm : [double precision] + is the specific gravity of moist or unsaturated sediments. if not specified, + then a default value of 1.7 is assigned. + sgs : [double precision] + is the specific gravity of saturated sediments. if not specified, then a + default value of 2.0 is assigned. + packagedata : [list] + stress_period_data : [list] """ @@ -311,11 +211,8 @@ class ModflowGwfcsub(mfpackage.MFPackage): package_abbr = "gwfcsub" _package_type = "csub" dfn_file_name = "gwf-csub.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name boundnames", @@ -344,7 +241,7 @@ class ModflowGwfcsub(mfpackage.MFPackage): "type double precision", "reader urword", "optional true", - "default_value 9806.65", + "default 9806.65", ], [ "block options", @@ -352,7 +249,7 @@ class ModflowGwfcsub(mfpackage.MFPackage): "type double precision", "reader urword", "optional true", - "default_value 4.6512e-10", + "default 4.6512e-10", ], [ "block options", @@ -745,8 +642,8 @@ class ModflowGwfcsub(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -788,7 +685,7 @@ class ModflowGwfcsub(mfpackage.MFPackage): "shape (nodes)", "valid", "reader readarray", - "default_value 1e-5", + "default 1e-5", ], [ "block griddata", @@ -797,7 +694,7 @@ class ModflowGwfcsub(mfpackage.MFPackage): "shape (nodes)", "valid", "reader readarray", - "default_value 0.2", + "default 0.2", ], [ "block griddata", @@ -820,8 +717,7 @@ class ModflowGwfcsub(mfpackage.MFPackage): [ "block packagedata", "name packagedata", - "type recarray icsubno cellid cdelay pcs0 thick_frac rnb ssv_cc " - "sse_cr theta kv h0 boundname", + "type recarray icsubno cellid cdelay pcs0 thick_frac rnb ssv_cc sse_cr theta kv h0 boundname", "shape (ninterbeds)", "reader urword", ], @@ -906,7 +802,7 @@ class ModflowGwfcsub(mfpackage.MFPackage): "tagged false", "in_record true", "reader urword", - "default_value 0.2", + "default 0.2", ], [ "block packagedata", @@ -1008,7 +904,7 @@ def __init__( observations=None, ninterbeds=None, maxsig0=None, - cg_ske_cr=1e-5, + cg_ske_cr=1e-05, cg_theta=0.2, sgm=None, sgs=None, @@ -1018,9 +914,150 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfcsub defines a CSUB package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of csub + cells. + print_input : keyword + keyword to indicate that the list of csub information will be written to the + listing file immediately after it is read. + save_flows : keyword + keyword to indicate that cell-by-cell flow terms will be written to the file + specified with 'budget save file' in output control. + gammaw : double precision + unit weight of water. for freshwater, gammaw is 9806.65 newtons/cubic meters or + 62.48 lb/cubic foot in si and english units, respectively. by default, gammaw + is 9806.65 newtons/cubic meters. + beta : double precision + compressibility of water. typical values of beta are 4.6512e-10 1/pa or + 2.2270e-8 lb/square foot in si and english units, respectively. by default, + beta is 4.6512e-10 1/pa. + head_based : keyword + keyword to indicate the head-based formulation will be used to simulate coarse- + grained aquifer materials and no-delay and delay interbeds. specifying + head_based also specifies the initial_preconsolidation_head option. + initial_preconsolidation_head : keyword + keyword to indicate that preconsolidation heads will be specified for no-delay + and delay interbeds in the packagedata block. if the + specified_initial_interbed_state option is specified in the options block, + user-specified preconsolidation heads in the packagedata block are absolute + values. otherwise, user-specified preconsolidation heads in the packagedata + block are relative to steady-state or initial heads. + ndelaycells : integer + number of nodes used to discretize delay interbeds. if not specified, then a + default value of 19 is assigned. + compression_indices : keyword + keyword to indicate that the recompression (cr) and compression (cc) indices + are specified instead of the elastic specific storage (sse) and inelastic + specific storage (ssv) coefficients. if not specified, then elastic specific + storage (sse) and inelastic specific storage (ssv) coefficients must be + specified. + update_material_properties : keyword + keyword to indicate that the thickness and void ratio of coarse-grained and + interbed sediments (delay and no-delay) will vary during the simulation. if not + specified, the thickness and void ratio of coarse-grained and interbed + sediments will not vary during the simulation. + cell_fraction : keyword + keyword to indicate that the thickness of interbeds will be specified in terms + of the fraction of cell thickness. if not specified, interbed thicknness must + be specified. + specified_initial_interbed_state : keyword + keyword to indicate that absolute preconsolidation stresses (heads) and delay + bed heads will be specified for interbeds defined in the packagedata block. the + specified_initial_interbed_state option is equivalent to specifying the + specified_initial_preconsolitation_stress and specified_initial_delay_head. if + specified_initial_interbed_state is not specified then preconsolidation stress + (head) and delay bed head values specified in the packagedata block are + relative to simulated values of the first stress period if steady-state or + initial stresses and gwf heads if the first stress period is transient. + specified_initial_preconsolidation_stress : keyword + keyword to indicate that absolute preconsolidation stresses (heads) will be + specified for interbeds defined in the packagedata block. if + specified_initial_preconsolitation_stress and specified_initial_interbed_state + are not specified then preconsolidation stress (head) values specified in the + packagedata block are relative to simulated values if the first stress period + is steady-state or initial stresses (heads) if the first stress period is + transient. + specified_initial_delay_head : keyword + keyword to indicate that absolute initial delay bed head will be specified for + interbeds defined in the packagedata block. if specified_initial_delay_head and + specified_initial_interbed_state are not specified then delay bed head values + specified in the packagedata block are relative to simulated values if the + first stress period is steady-state or initial gwf heads if the first stress + period is transient. + effective_stress_lag : keyword + keyword to indicate the effective stress from the previous time step will be + used to calculate specific storage values. this option can 1) help with + convergence in models with thin cells and water table elevations close to land + surface; 2) is identical to the approach used in the subwt package for + modflow-2005; and 3) is only used if the effective-stress formulation is being + used. by default, current effective stress values are used to calculate + specific storage values. + strainib_filerecord : record + straincg_filerecord : record + compaction_filerecord : record + compaction_elastic_filerecord : record + compaction_inelastic_filerecord : record + compaction_interbed_filerecord : record + compaction_coarse_filerecord : record + zdisplacement_filerecord : record + package_convergence_filerecord : record + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + ninterbeds : integer + is the number of csub interbed systems. more than 1 csub interbed systems can + be assigned to a gwf cell; however, only 1 gwf cell can be assigned to a single + csub interbed system. + maxsig0 : integer + is the maximum number of cells that can have a specified stress offset. more + than 1 stress offset can be assigned to a gwf cell. by default, maxsig0 is 0. + cg_ske_cr : [double precision] + is the initial elastic coarse-grained material specific storage or + recompression index. the recompression index is specified if + compression_indices is specified in the options block. specified or calculated + elastic coarse-grained material specific storage values are not adjusted from + initial values if head_based is specified in the options block. + cg_theta : [double precision] + is the initial porosity of coarse-grained materials. + sgm : [double precision] + is the specific gravity of moist or unsaturated sediments. if not specified, + then a default value of 1.7 is assigned. + sgs : [double precision] + is the specific gravity of saturated sediments. if not specified, then a + default value of 2.0 is assigned. + packagedata : [list] + stress_period_data : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "csub", filename, pname, loading_package, **kwargs) - # set up variables self.boundnames = self.build_mfdata("boundnames", boundnames) self.print_input = self.build_mfdata("print_input", print_input) self.save_flows = self.build_mfdata("save_flows", save_flows) @@ -1096,4 +1133,5 @@ def __init__( self.stress_period_data = self.build_mfdata( "stress_period_data", stress_period_data ) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfdis.py b/flopy/mf6/modflow/mfgwfdis.py index 7ac6b2de38..9d43fb82ea 100644 --- a/flopy/mf6/modflow/mfgwfdis.py +++ b/flopy/mf6/modflow/mfgwfdis.py @@ -1,96 +1,84 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfdis(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfdis(MFPackage): """ - ModflowGwfdis defines a dis package within a gwf6 model. + ModflowGwfdis defines a DIS package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. length_units : string - * length_units (string) is the length units used for this model. Values - can be "FEET", "METERS", or "CENTIMETERS". If not specified, the - default is "UNKNOWN". - nogrb : boolean - * nogrb (boolean) keyword to deactivate writing of the binary grid - file. - xorigin : double - * xorigin (double) 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. - yorigin : double - * yorigin (double) 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. - angrot : double - * angrot (double) 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. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. - export_array_netcdf : boolean - * export_array_netcdf (boolean) keyword that specifies input griddata - arrays should be written to the model output netcdf file. - packagedata : {varname:data} or packagedata data - * Contains data for the ncf package. Data can be stored in a dictionary - containing data for the ncf package with variable names as keys and - package data as values. Data just for the packagedata variable is - also acceptable. See ncf package documentation for more information. + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : (grb6_filename) + * grb6_filename : string + 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'. + + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + packagedata : record ncf6 filein ncf6_filename + Contains data for the ncf package. Data can be passed as a dictionary to the + ncf package with variable names as keys and package data as values. Data for + the packagedata variable is also acceptable. See ncf package documentation for + more information. nlay : integer - * nlay (integer) is the number of layers in the model grid. + is the number of layers in the model grid. nrow : integer - * nrow (integer) is the number of rows in the model grid. + is the number of rows in the model grid. ncol : integer - * ncol (integer) is the number of columns in the model grid. - delr : [double] - * delr (double) is the column spacing in the row direction. - delc : [double] - * delc (double) is the row spacing in the column direction. - top : [double] - * top (double) is the top elevation for each cell in the top model - layer. - botm : [double] - * botm (double) is the bottom elevation for each cell. + is the number of columns in the model grid. + delr : [double precision] + is the column spacing in the row direction. + delc : [double precision] + is the row spacing in the column direction. + top : [double precision] + is the top elevation for each cell in the top model layer. + botm : [double precision] + is the bottom elevation for each cell. idomain : [integer] - * idomain (integer) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. """ + grb_filerecord = ListTemplateGenerator(("gwf6", "dis", "options", "grb_filerecord")) ncf_filerecord = ListTemplateGenerator(("gwf6", "dis", "options", "ncf_filerecord")) delr = ArrayTemplateGenerator(("gwf6", "dis", "griddata", "delr")) delc = ArrayTemplateGenerator(("gwf6", "dis", "griddata", "delc")) @@ -100,11 +88,8 @@ class ModflowGwfdis(mfpackage.MFPackage): package_abbr = "gwfdis" _package_type = "dis" dfn_file_name = "gwf-dis.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name length_units", @@ -119,6 +104,44 @@ class ModflowGwfdis(mfpackage.MFPackage): "reader urword", "optional true", ], + [ + "block options", + "name grb_filerecord", + "type record grb6 fileout grb6_filename", + "reader urword", + "tagged true", + "optional true", + ], + [ + "block options", + "name grb6", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + "extended true", + ], + [ + "block options", + "name fileout", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + ], + [ + "block options", + "name grb6_filename", + "type string", + "preserve_case true", + "in_record true", + "reader urword", + "optional false", + "tagged false", + "extended true", + ], [ "block options", "name xorigin", @@ -204,7 +227,7 @@ class ModflowGwfdis(mfpackage.MFPackage): "type integer", "reader urword", "optional false", - "default_value 1", + "default 1", ], [ "block dimensions", @@ -212,7 +235,7 @@ class ModflowGwfdis(mfpackage.MFPackage): "type integer", "reader urword", "optional false", - "default_value 2", + "default 2", ], [ "block dimensions", @@ -220,7 +243,7 @@ class ModflowGwfdis(mfpackage.MFPackage): "type integer", "reader urword", "optional false", - "default_value 2", + "default 2", ], [ "block griddata", @@ -229,7 +252,7 @@ class ModflowGwfdis(mfpackage.MFPackage): "shape (ncol)", "reader readarray", "netcdf true", - "default_value 1.0", + "default 1.0", ], [ "block griddata", @@ -238,7 +261,7 @@ class ModflowGwfdis(mfpackage.MFPackage): "shape (nrow)", "reader readarray", "netcdf true", - "default_value 1.0", + "default 1.0", ], [ "block griddata", @@ -247,7 +270,7 @@ class ModflowGwfdis(mfpackage.MFPackage): "shape (ncol, nrow)", "reader readarray", "netcdf true", - "default_value 1.0", + "default 1.0", ], [ "block griddata", @@ -257,7 +280,7 @@ class ModflowGwfdis(mfpackage.MFPackage): "reader readarray", "layered true", "netcdf true", - "default_value 0.", + "default 0.", ], [ "block griddata", @@ -277,6 +300,7 @@ def __init__( loading_package=False, length_units=None, nogrb=None, + grb_filerecord=None, xorigin=None, yorigin=None, angrot=None, @@ -295,11 +319,90 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfdis defines a DIS package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + length_units : string + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : record + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + packagedata : record ncf6 filein ncf6_filename + Contains data for the ncf package. Data can be passed as a dictionary to the + ncf package with variable names as keys and package data as values. Data for + the packagedata variable is also acceptable. See ncf package documentation for + more information. + nlay : integer + is the number of layers in the model grid. + nrow : integer + is the number of rows in the model grid. + ncol : integer + is the number of columns in the model grid. + delr : [double precision] + is the column spacing in the row direction. + delc : [double precision] + is the row spacing in the column direction. + top : [double precision] + is the top elevation for each cell in the top model layer. + botm : [double precision] + is the bottom elevation for each cell. + idomain : [integer] + 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. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "dis", filename, pname, loading_package, **kwargs) - # set up variables self.length_units = self.build_mfdata("length_units", length_units) self.nogrb = self.build_mfdata("nogrb", nogrb) + self.grb_filerecord = self.build_mfdata("grb_filerecord", grb_filerecord) self.xorigin = self.build_mfdata("xorigin", xorigin) self.yorigin = self.build_mfdata("yorigin", yorigin) self.angrot = self.build_mfdata("angrot", angrot) @@ -321,4 +424,5 @@ def __init__( self.top = self.build_mfdata("top", top) self.botm = self.build_mfdata("botm", botm) self.idomain = self.build_mfdata("idomain", idomain) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfdisu.py b/flopy/mf6/modflow/mfgwfdisu.py index ad90b32e5b..0de540d188 100644 --- a/flopy/mf6/modflow/mfgwfdisu.py +++ b/flopy/mf6/modflow/mfgwfdisu.py @@ -1,194 +1,147 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfdisu(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfdisu(MFPackage): """ - ModflowGwfdisu defines a disu package within a gwf6 model. + ModflowGwfdisu defines a DISU package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. length_units : string - * length_units (string) is the length units used for this model. Values - can be "FEET", "METERS", or "CENTIMETERS". If not specified, the - default is "UNKNOWN". - nogrb : boolean - * nogrb (boolean) keyword to deactivate writing of the binary grid - file. - xorigin : double - * xorigin (double) 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. - yorigin : double - * yorigin (double) 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. - angrot : double - * angrot (double) 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. - vertical_offset_tolerance : double - * vertical_offset_tolerance (double) 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. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : (grb6_filename) + * grb6_filename : string + 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'. + + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + vertical_offset_tolerance : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. nodes : integer - * nodes (integer) is the number of cells in the model grid. + is the number of cells in the model grid. nja : integer - * nja (integer) 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. + 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. nvert : integer - * nvert (integer) 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. - top : [double] - * top (double) is the top elevation for each cell in the model grid. - bot : [double] - * bot (double) is the bottom elevation for each cell. - area : [double] - * area (double) is the cell surface area (in plan view). + 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. + top : [double precision] + is the top elevation for each cell in the model grid. + bot : [double precision] + is the bottom elevation for each cell. + area : [double precision] + is the cell surface area (in plan view). idomain : [integer] - * idomain (integer) 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. + 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. iac : [integer] - * iac (integer) is the number of connections (plus 1) for each cell. - The sum of all the entries in IAC must be equal to NJA. + is the number of connections (plus 1) for each cell. the sum of all the + entries in iac must be equal to nja. ja : [integer] - * ja (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. + 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. ihc : [integer] - * ihc (integer) 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. - cl12 : [double] - * cl12 (double) is the array containing connection lengths between the - center of cell n and the shared face with each adjacent m cell. - hwva : [double] - * hwva (double) 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. - angldegx : [double] - * angldegx (double) 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. - vertices : [iv, xv, yv] - * iv (integer) is the vertex number. Records in the VERTICES block must - be listed in consecutive order from 1 to NVERT. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - * xv (double) is the x-coordinate for the vertex. - * yv (double) is the y-coordinate for the vertex. - cell2d : [icell2d, xc, yc, ncvert, icvert] - * icell2d (integer) is the cell2d number. Records in the CELL2D block - must be listed in consecutive order from 1 to NODES. This argument is - an index variable, which means that it should be treated as zero- - based when working with FloPy and Python. Flopy will automatically - subtract one when loading index variables and add one when writing - index variables. - * xc (double) is the x-coordinate for the cell center. - * yc (double) is the y-coordinate for the cell center. - * ncvert (integer) is the number of vertices required to define the - cell. There may be a different number of vertices for each cell. - * icvert (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + cl12 : [double precision] + is the array containing connection lengths between the center of cell n and the + shared face with each adjacent m cell. + hwva : [double precision] + 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. + angldegx : [double precision] + 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. + vertices : [list] + cell2d : [list] """ + grb_filerecord = ListTemplateGenerator( + ("gwf6", "disu", "options", "grb_filerecord") + ) top = ArrayTemplateGenerator(("gwf6", "disu", "griddata", "top")) bot = ArrayTemplateGenerator(("gwf6", "disu", "griddata", "bot")) area = ArrayTemplateGenerator(("gwf6", "disu", "griddata", "area")) @@ -204,11 +157,8 @@ class ModflowGwfdisu(mfpackage.MFPackage): package_abbr = "gwfdisu" _package_type = "disu" dfn_file_name = "gwf-disu.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name length_units", @@ -223,6 +173,44 @@ class ModflowGwfdisu(mfpackage.MFPackage): "reader urword", "optional true", ], + [ + "block options", + "name grb_filerecord", + "type record grb6 fileout grb6_filename", + "reader urword", + "tagged true", + "optional true", + ], + [ + "block options", + "name grb6", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + "extended true", + ], + [ + "block options", + "name fileout", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + ], + [ + "block options", + "name grb6_filename", + "type string", + "preserve_case true", + "in_record true", + "reader urword", + "optional false", + "tagged false", + "extended true", + ], [ "block options", "name xorigin", @@ -250,7 +238,7 @@ class ModflowGwfdisu(mfpackage.MFPackage): "type double precision", "reader urword", "optional true", - "default_value 0.0", + "default 0.0", "mf6internal voffsettol", ], [ @@ -461,6 +449,7 @@ def __init__( loading_package=False, length_units=None, nogrb=None, + grb_filerecord=None, xorigin=None, yorigin=None, angrot=None, @@ -485,11 +474,151 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfdisu defines a DISU package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + length_units : string + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : record + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + vertical_offset_tolerance : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + nodes : integer + is the number of cells in the model grid. + nja : integer + 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. + nvert : integer + 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. + top : [double precision] + is the top elevation for each cell in the model grid. + bot : [double precision] + is the bottom elevation for each cell. + area : [double precision] + is the cell surface area (in plan view). + idomain : [integer] + 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. + iac : [integer] + is the number of connections (plus 1) for each cell. the sum of all the + entries in iac must be equal to nja. + ja : [integer] + 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. + ihc : [integer] + 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. + cl12 : [double precision] + is the array containing connection lengths between the center of cell n and the + shared face with each adjacent m cell. + hwva : [double precision] + 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. + angldegx : [double precision] + 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. + vertices : [list] + cell2d : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "disu", filename, pname, loading_package, **kwargs) - # set up variables self.length_units = self.build_mfdata("length_units", length_units) self.nogrb = self.build_mfdata("nogrb", nogrb) + self.grb_filerecord = self.build_mfdata("grb_filerecord", grb_filerecord) self.xorigin = self.build_mfdata("xorigin", xorigin) self.yorigin = self.build_mfdata("yorigin", yorigin) self.angrot = self.build_mfdata("angrot", angrot) @@ -514,4 +643,5 @@ def __init__( self.angldegx = self.build_mfdata("angldegx", angldegx) self.vertices = self.build_mfdata("vertices", vertices) self.cell2d = self.build_mfdata("cell2d", cell2d) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfdisv.py b/flopy/mf6/modflow/mfgwfdisv.py index 390a8c7c60..bc599b6bd3 100644 --- a/flopy/mf6/modflow/mfgwfdisv.py +++ b/flopy/mf6/modflow/mfgwfdisv.py @@ -1,124 +1,89 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfdisv(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfdisv(MFPackage): """ - ModflowGwfdisv defines a disv package within a gwf6 model. + ModflowGwfdisv defines a DISV package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. length_units : string - * length_units (string) is the length units used for this model. Values - can be "FEET", "METERS", or "CENTIMETERS". If not specified, the - default is "UNKNOWN". - nogrb : boolean - * nogrb (boolean) keyword to deactivate writing of the binary grid - file. - xorigin : double - * xorigin (double) 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. - yorigin : double - * yorigin (double) 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. - angrot : double - * angrot (double) 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. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. - export_array_netcdf : boolean - * export_array_netcdf (boolean) keyword that specifies input griddata - arrays should be written to the model output netcdf file. - packagedata : {varname:data} or packagedata data - * Contains data for the ncf package. Data can be stored in a dictionary - containing data for the ncf package with variable names as keys and - package data as values. Data just for the packagedata variable is - also acceptable. See ncf package documentation for more information. + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : (grb6_filename) + * grb6_filename : string + 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'. + + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + packagedata : record ncf6 filein ncf6_filename + Contains data for the ncf package. Data can be passed as a dictionary to the + ncf package with variable names as keys and package data as values. Data for + the packagedata variable is also acceptable. See ncf package documentation for + more information. nlay : integer - * nlay (integer) is the number of layers in the model grid. + is the number of layers in the model grid. ncpl : integer - * ncpl (integer) is the number of cells per layer. This is a constant - value for the grid and it applies to all layers. + is the number of cells per layer. this is a constant value for the grid and it + applies to all layers. nvert : integer - * nvert (integer) is the total number of (x, y) vertex pairs used to - characterize the horizontal configuration of the model grid. - top : [double] - * top (double) is the top elevation for each cell in the top model - layer. - botm : [double] - * botm (double) is the bottom elevation for each cell. + is the total number of (x, y) vertex pairs used to characterize the horizontal + configuration of the model grid. + top : [double precision] + is the top elevation for each cell in the top model layer. + botm : [double precision] + is the bottom elevation for each cell. idomain : [integer] - * idomain (integer) 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. - vertices : [iv, xv, yv] - * iv (integer) is the vertex number. Records in the VERTICES block must - be listed in consecutive order from 1 to NVERT. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - * xv (double) is the x-coordinate for the vertex. - * yv (double) is the y-coordinate for the vertex. - cell2d : [icell2d, xc, yc, ncvert, icvert] - * icell2d (integer) is the CELL2D number. Records in the CELL2D block - must be listed in consecutive order from the first to the last. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * xc (double) is the x-coordinate for the cell center. - * yc (double) is the y-coordinate for the cell center. - * ncvert (integer) is the number of vertices required to define the - cell. There may be a different number of vertices for each cell. - * icvert (integer) 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. This argument is an index variable, which means that - it should be treated as zero-based when working with FloPy and - Python. Flopy will automatically subtract one when loading index - variables and add one when writing index variables. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + vertices : [list] + cell2d : [list] """ + grb_filerecord = ListTemplateGenerator( + ("gwf6", "disv", "options", "grb_filerecord") + ) ncf_filerecord = ListTemplateGenerator( ("gwf6", "disv", "options", "ncf_filerecord") ) @@ -130,11 +95,8 @@ class ModflowGwfdisv(mfpackage.MFPackage): package_abbr = "gwfdisv" _package_type = "disv" dfn_file_name = "gwf-disv.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name length_units", @@ -149,6 +111,44 @@ class ModflowGwfdisv(mfpackage.MFPackage): "reader urword", "optional true", ], + [ + "block options", + "name grb_filerecord", + "type record grb6 fileout grb6_filename", + "reader urword", + "tagged true", + "optional true", + ], + [ + "block options", + "name grb6", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + "extended true", + ], + [ + "block options", + "name fileout", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + ], + [ + "block options", + "name grb6_filename", + "type string", + "preserve_case true", + "in_record true", + "reader urword", + "optional false", + "tagged false", + "extended true", + ], [ "block options", "name xorigin", @@ -376,6 +376,7 @@ def __init__( loading_package=False, length_units=None, nogrb=None, + grb_filerecord=None, xorigin=None, yorigin=None, angrot=None, @@ -394,11 +395,93 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfdisv defines a DISV package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + length_units : string + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : record + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + packagedata : record ncf6 filein ncf6_filename + Contains data for the ncf package. Data can be passed as a dictionary to the + ncf package with variable names as keys and package data as values. Data for + the packagedata variable is also acceptable. See ncf package documentation for + more information. + nlay : integer + is the number of layers in the model grid. + ncpl : integer + is the number of cells per layer. this is a constant value for the grid and it + applies to all layers. + nvert : integer + is the total number of (x, y) vertex pairs used to characterize the horizontal + configuration of the model grid. + top : [double precision] + is the top elevation for each cell in the top model layer. + botm : [double precision] + is the bottom elevation for each cell. + idomain : [integer] + 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. + vertices : [list] + cell2d : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "disv", filename, pname, loading_package, **kwargs) - # set up variables self.length_units = self.build_mfdata("length_units", length_units) self.nogrb = self.build_mfdata("nogrb", nogrb) + self.grb_filerecord = self.build_mfdata("grb_filerecord", grb_filerecord) self.xorigin = self.build_mfdata("xorigin", xorigin) self.yorigin = self.build_mfdata("yorigin", yorigin) self.angrot = self.build_mfdata("angrot", angrot) @@ -420,4 +503,5 @@ def __init__( self.idomain = self.build_mfdata("idomain", idomain) self.vertices = self.build_mfdata("vertices", vertices) self.cell2d = self.build_mfdata("cell2d", cell2d) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfdrn.py b/flopy/mf6/modflow/mfgwfdrn.py index bf28052104..d0ff54cf59 100644 --- a/flopy/mf6/modflow/mfgwfdrn.py +++ b/flopy/mf6/modflow/mfgwfdrn.py @@ -1,134 +1,83 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfdrn(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfdrn(MFPackage): """ - ModflowGwfdrn defines a drn package within a gwf6 model. + ModflowGwfdrn defines a DRN package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. auxiliary : [string] - * auxiliary (string) 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. + 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. auxmultname : string - * auxmultname (string) name of auxiliary variable to be used as - multiplier of drain conductance. + name of auxiliary variable to be used as multiplier of drain conductance. auxdepthname : string - * auxdepthname (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of drain cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of drain - information will be written to the listing file immediately after it - is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that drain flow terms will - be written to the file specified with "BUDGET FILEOUT" in Output - Control. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - mover : boolean - * mover (boolean) 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. - dev_cubic_scaling : boolean - * dev_cubic_scaling (boolean) cubic-scaling is used to scale the drain - conductance + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of drain + cells. + print_input : keyword + keyword to indicate that the list of drain information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that drain flow terms will be written to the file specified + with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. + dev_cubic_scaling : keyword + cubic-scaling is used to scale the drain conductance maxbound : integer - * maxbound (integer) integer value specifying the maximum number of - drains cells that will be specified for use during any stress period. - stress_period_data : [cellid, elev, cond, aux, boundname] - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * elev (double) 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. - * cond (double) 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. - * aux (double) 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. - * boundname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the maximum number of drains cells that will be + specified for use during any stress period. + stress_period_data : [list] """ - auxiliary = ListTemplateGenerator(("gwf6", "drn", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwf6", "drn", "options", "auxiliary")) ts_filerecord = ListTemplateGenerator(("gwf6", "drn", "options", "ts_filerecord")) obs_filerecord = ListTemplateGenerator(("gwf6", "drn", "options", "obs_filerecord")) stress_period_data = ListTemplateGenerator( @@ -137,7 +86,6 @@ class ModflowGwfdrn(mfpackage.MFPackage): package_abbr = "gwfdrn" _package_type = "drn" dfn_file_name = "gwf-drn.dfn" - dfn = [ ["header", "multi-package", "package-type stress-package"], [ @@ -247,8 +195,8 @@ class ModflowGwfdrn(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -387,9 +335,91 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfdrn defines a DRN package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + auxiliary : [string] + 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. + auxmultname : string + name of auxiliary variable to be used as multiplier of drain conductance. + auxdepthname : string + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of drain + cells. + print_input : keyword + keyword to indicate that the list of drain information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that drain flow terms will be written to the file specified + with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. + dev_cubic_scaling : keyword + cubic-scaling is used to scale the drain conductance + maxbound : integer + integer value specifying the maximum number of drains cells that will be + specified for use during any stress period. + stress_period_data : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "drn", filename, pname, loading_package, **kwargs) - # set up variables self.auxiliary = self.build_mfdata("auxiliary", auxiliary) self.auxmultname = self.build_mfdata("auxmultname", auxmultname) self.auxdepthname = self.build_mfdata("auxdepthname", auxdepthname) @@ -413,4 +443,5 @@ def __init__( self.stress_period_data = self.build_mfdata( "stress_period_data", stress_period_data ) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfevt.py b/flopy/mf6/modflow/mfgwfevt.py index 81b6dd2252..7f0f3f8507 100644 --- a/flopy/mf6/modflow/mfgwfevt.py +++ b/flopy/mf6/modflow/mfgwfevt.py @@ -1,151 +1,77 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfevt(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfevt(MFPackage): """ - ModflowGwfevt defines a evt package within a gwf6 model. + ModflowGwfevt defines a EVT package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - fixed_cell : boolean - * fixed_cell (boolean) indicates that evapotranspiration will not be - reassigned to a cell underlying the cell specified in the list if the - specified cell is inactive. + fixed_cell : keyword + indicates that evapotranspiration will not be reassigned to a cell underlying + the cell specified in the list if the specified cell is inactive. auxiliary : [string] - * auxiliary (string) 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. + 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. auxmultname : string - * auxmultname (string) name of auxiliary variable to be used as - multiplier of evapotranspiration rate. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of evapotranspiration cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of - evapotranspiration information will be written to the listing file - immediately after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that evapotranspiration flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - surf_rate_specified : boolean - * surf_rate_specified (boolean) indicates that the proportion of the - evapotranspiration rate at the ET surface will be specified as PETM0 - in list input. + name of auxiliary variable to be used as multiplier of evapotranspiration rate. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + evapotranspiration cells. + print_input : keyword + keyword to indicate that the list of evapotranspiration information will be + written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that evapotranspiration flow terms will be written to the + file specified with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + surf_rate_specified : keyword + indicates that the proportion of the evapotranspiration rate at the et surface + will be specified as petm0 in list input. maxbound : integer - * maxbound (integer) integer value specifying the maximum number of - evapotranspiration cells cells that will be specified for use during - any stress period. + integer value specifying the maximum number of evapotranspiration cells cells + that will be specified for use during any stress period. nseg : integer - * nseg (integer) 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. - stress_period_data : [cellid, surface, rate, depth, pxdp, petm, petm0, aux, - boundname] - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * surface (double) is the elevation of the ET surface (:math:`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. - * rate (double) is the maximum ET flux rate (:math:`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. - * depth (double) is the ET extinction depth (:math:`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. - * pxdp (double) 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. - * petm (double) 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. - * petm0 (double) 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. - * aux (double) 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. - * boundname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + stress_period_data : [list] """ - auxiliary = ListTemplateGenerator(("gwf6", "evt", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwf6", "evt", "options", "auxiliary")) ts_filerecord = ListTemplateGenerator(("gwf6", "evt", "options", "ts_filerecord")) obs_filerecord = ListTemplateGenerator(("gwf6", "evt", "options", "obs_filerecord")) stress_period_data = ListTemplateGenerator( @@ -154,7 +80,6 @@ class ModflowGwfevt(mfpackage.MFPackage): package_abbr = "gwfevt" _package_type = "evt" dfn_file_name = "gwf-evt.dfn" - dfn = [ ["header", "multi-package", "package-type stress-package"], [ @@ -264,8 +189,8 @@ class ModflowGwfevt(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -446,9 +371,85 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfevt defines a EVT package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + fixed_cell : keyword + indicates that evapotranspiration will not be reassigned to a cell underlying + the cell specified in the list if the specified cell is inactive. + auxiliary : [string] + 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. + auxmultname : string + name of auxiliary variable to be used as multiplier of evapotranspiration rate. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + evapotranspiration cells. + print_input : keyword + keyword to indicate that the list of evapotranspiration information will be + written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that evapotranspiration flow terms will be written to the + file specified with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + surf_rate_specified : keyword + indicates that the proportion of the evapotranspiration rate at the et surface + will be specified as petm0 in list input. + maxbound : integer + integer value specifying the maximum number of evapotranspiration cells cells + that will be specified for use during any stress period. + nseg : integer + 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. + stress_period_data : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "evt", filename, pname, loading_package, **kwargs) - # set up variables self.fixed_cell = self.build_mfdata("fixed_cell", fixed_cell) self.auxiliary = self.build_mfdata("auxiliary", auxiliary) self.auxmultname = self.build_mfdata("auxmultname", auxmultname) @@ -472,4 +473,5 @@ def __init__( self.stress_period_data = self.build_mfdata( "stress_period_data", stress_period_data ) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfevta.py b/flopy/mf6/modflow/mfgwfevta.py index 821ea9e1c0..7047e46084 100644 --- a/flopy/mf6/modflow/mfgwfevta.py +++ b/flopy/mf6/modflow/mfgwfevta.py @@ -1,113 +1,90 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfevta(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfevta(MFPackage): """ - ModflowGwfevta defines a evta package within a gwf6 model. + ModflowGwfevta defines a EVTA package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - readasarrays : boolean - * readasarrays (boolean) 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. - fixed_cell : boolean - * fixed_cell (boolean) indicates that evapotranspiration will not be - reassigned to a cell underlying the cell specified in the list if the - specified cell is inactive. + readasarrays : keyword + 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. + fixed_cell : keyword + indicates that evapotranspiration will not be reassigned to a cell underlying + the cell specified in the list if the specified cell is inactive. auxiliary : [string] - * auxiliary (string) 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. + 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. auxmultname : string - * auxmultname (string) name of auxiliary variable to be used as - multiplier of evapotranspiration rate. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of - evapotranspiration information will be written to the listing file - immediately after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that evapotranspiration flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - timearrayseries : {varname:data} or tas_array data - * Contains data for the tas package. Data can be stored in a dictionary - containing data for the tas package with variable names as keys and - package data as values. Data just for the timearrayseries variable is - also acceptable. See tas package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - export_array_netcdf : boolean - * export_array_netcdf (boolean) keyword that specifies input griddata - arrays should be written to the model output netcdf file. + name of auxiliary variable to be used as multiplier of evapotranspiration rate. + print_input : keyword + keyword to indicate that the list of evapotranspiration information will be + written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that evapotranspiration flow terms will be written to the + file specified with 'budget fileout' in output control. + timearrayseries : record tas6 filein tas6_filename + Contains data for the tas package. Data can be passed as a dictionary to the + tas package with variable names as keys and package data as values. Data for + the timearrayseries variable is also acceptable. See tas package documentation + for more information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. ievt : [integer] - * ievt (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - surface : [double] - * surface (double) is the elevation of the ET surface (:math:`L`). - rate : [double] - * rate (double) is the maximum ET flux rate (:math:`LT^{-1}`). - depth : [double] - * depth (double) is the ET extinction depth (:math:`L`). - aux : [double] - * aux (double) 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 a value of zero is assigned. If the value - specified here for the auxiliary variable is the same as auxmultname, - then the evapotranspiration rate will be multiplied by this array. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + surface : [double precision] + is the elevation of the et surface (:math:`l`). + rate : [double precision] + is the maximum et flux rate (:math:`lt^{-1}`). + depth : [double precision] + is the et extinction depth (:math:`l`). + aux : [double precision] + 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 a value of zero is + assigned. if the value specified here for the auxiliary variable is the same + as auxmultname, then the evapotranspiration rate will be multiplied by this + array. """ - auxiliary = ListTemplateGenerator(("gwf6", "evta", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwf6", "evta", "options", "auxiliary")) tas_filerecord = ListTemplateGenerator( ("gwf6", "evta", "options", "tas_filerecord") ) @@ -122,7 +99,6 @@ class ModflowGwfevta(mfpackage.MFPackage): package_abbr = "gwfevta" _package_type = "evta" dfn_file_name = "gwf-evta.dfn" - dfn = [ ["header", "multi-package", "package-type stress-package"], [ @@ -132,7 +108,7 @@ class ModflowGwfevta(mfpackage.MFPackage): "shape", "reader urword", "optional false", - "default_value True", + "default True", ], [ "block options", @@ -191,8 +167,8 @@ class ModflowGwfevta(mfpackage.MFPackage): "tagged true", "optional true", "construct_package tas", - "construct_data tas_array", - "parameter_name timearrayseries", + "construct_data timearrayseries", + "parameter_name tas_array", ], [ "block options", @@ -233,8 +209,8 @@ class ModflowGwfevta(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -292,7 +268,7 @@ class ModflowGwfevta(mfpackage.MFPackage): "type double precision", "shape (ncol*nrow; ncpl)", "reader readarray", - "default_value 0.", + "default 0.", ], [ "block period", @@ -301,7 +277,7 @@ class ModflowGwfevta(mfpackage.MFPackage): "shape (ncol*nrow; ncpl)", "reader readarray", "time_series true", - "default_value 1.e-3", + "default 1.e-3", ], [ "block period", @@ -309,7 +285,7 @@ class ModflowGwfevta(mfpackage.MFPackage): "type double precision", "shape (ncol*nrow; ncpl)", "reader readarray", - "default_value 1.0", + "default 1.0", ], [ "block period", @@ -338,16 +314,105 @@ def __init__( export_array_netcdf=None, ievt=None, surface=0.0, - rate=1.0e-3, + rate=0.001, depth=1.0, aux=None, filename=None, pname=None, **kwargs, ): + """ + ModflowGwfevta defines a EVTA package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + readasarrays : keyword + 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. + fixed_cell : keyword + indicates that evapotranspiration will not be reassigned to a cell underlying + the cell specified in the list if the specified cell is inactive. + auxiliary : [string] + 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. + auxmultname : string + name of auxiliary variable to be used as multiplier of evapotranspiration rate. + print_input : keyword + keyword to indicate that the list of evapotranspiration information will be + written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that evapotranspiration flow terms will be written to the + file specified with 'budget fileout' in output control. + timearrayseries : record tas6 filein tas6_filename + Contains data for the tas package. Data can be passed as a dictionary to the + tas package with variable names as keys and package data as values. Data for + the timearrayseries variable is also acceptable. See tas package documentation + for more information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + ievt : [integer] + 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. + surface : [double precision] + is the elevation of the et surface (:math:`l`). + rate : [double precision] + is the maximum et flux rate (:math:`lt^{-1}`). + depth : [double precision] + is the et extinction depth (:math:`l`). + aux : [double precision] + 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 a value of zero is + assigned. if the value specified here for the auxiliary variable is the same + as auxmultname, then the evapotranspiration rate will be multiplied by this + array. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "evta", filename, pname, loading_package, **kwargs) - # set up variables self.readasarrays = self.build_mfdata("readasarrays", readasarrays) self.fixed_cell = self.build_mfdata("fixed_cell", fixed_cell) self.auxiliary = self.build_mfdata("auxiliary", auxiliary) @@ -371,4 +436,5 @@ def __init__( self.rate = self.build_mfdata("rate", rate) self.depth = self.build_mfdata("depth", depth) self.aux = self.build_mfdata("aux", aux) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfghb.py b/flopy/mf6/modflow/mfgwfghb.py index ba6e075e53..aa96cf7e89 100644 --- a/flopy/mf6/modflow/mfgwfghb.py +++ b/flopy/mf6/modflow/mfgwfghb.py @@ -1,119 +1,70 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfghb(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfghb(MFPackage): """ - ModflowGwfghb defines a ghb package within a gwf6 model. + ModflowGwfghb defines a GHB package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. auxiliary : [string] - * auxiliary (string) 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. + 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. auxmultname : string - * auxmultname (string) name of auxiliary variable to be used as - multiplier of general-head boundary conductance. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of general-head boundary cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of general- - head boundary information will be written to the listing file - immediately after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that general-head boundary - flow terms will be written to the file specified with "BUDGET - FILEOUT" in Output Control. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - mover : boolean - * mover (boolean) 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. + name of auxiliary variable to be used as multiplier of general-head boundary + conductance. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + general-head boundary cells. + print_input : keyword + keyword to indicate that the list of general-head boundary information will be + written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that general-head boundary flow terms will be written to + the file specified with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. maxbound : integer - * maxbound (integer) integer value specifying the maximum number of - general-head boundary cells that will be specified for use during any - stress period. - stress_period_data : [cellid, bhead, cond, aux, boundname] - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * bhead (double) 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. - * cond (double) 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. - * aux (double) 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. - * boundname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the maximum number of general-head boundary cells that + will be specified for use during any stress period. + stress_period_data : [list] """ - auxiliary = ListTemplateGenerator(("gwf6", "ghb", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwf6", "ghb", "options", "auxiliary")) ts_filerecord = ListTemplateGenerator(("gwf6", "ghb", "options", "ts_filerecord")) obs_filerecord = ListTemplateGenerator(("gwf6", "ghb", "options", "obs_filerecord")) stress_period_data = ListTemplateGenerator( @@ -122,7 +73,6 @@ class ModflowGwfghb(mfpackage.MFPackage): package_abbr = "gwfghb" _package_type = "ghb" dfn_file_name = "gwf-ghb.dfn" - dfn = [ ["header", "multi-package", "package-type stress-package"], [ @@ -224,8 +174,8 @@ class ModflowGwfghb(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -354,9 +304,78 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfghb defines a GHB package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + auxiliary : [string] + 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. + auxmultname : string + name of auxiliary variable to be used as multiplier of general-head boundary + conductance. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + general-head boundary cells. + print_input : keyword + keyword to indicate that the list of general-head boundary information will be + written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that general-head boundary flow terms will be written to + the file specified with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. + maxbound : integer + integer value specifying the maximum number of general-head boundary cells that + will be specified for use during any stress period. + stress_period_data : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "ghb", filename, pname, loading_package, **kwargs) - # set up variables self.auxiliary = self.build_mfdata("auxiliary", auxiliary) self.auxmultname = self.build_mfdata("auxmultname", auxmultname) self.boundnames = self.build_mfdata("boundnames", boundnames) @@ -376,4 +395,5 @@ def __init__( self.stress_period_data = self.build_mfdata( "stress_period_data", stress_period_data ) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfgnc.py b/flopy/mf6/modflow/mfgwfgnc.py index 3494446ac6..a74f1a6e4a 100644 --- a/flopy/mf6/modflow/mfgwfgnc.py +++ b/flopy/mf6/modflow/mfgwfgnc.py @@ -1,100 +1,41 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfgnc(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfgnc(MFPackage): """ - ModflowGwfgnc defines a gnc package within a gwf6 model. + ModflowGwfgnc defines a GNC package. Parameters ---------- - parent_model_or_package : MFModel/MFPackage - Parent_model_or_package that this package is a part of. Package is automatically - added to parent_model_or_package when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of GNC - information will be written to the listing file immediately after it - is read. - print_flows : boolean - * print_flows (boolean) 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. - explicit : boolean - * explicit (boolean) 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. + print_input : keyword + keyword to indicate that the list of gnc information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + explicit : keyword + 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. numgnc : integer - * numgnc (integer) is the number of GNC entries. + is the number of gnc entries. numalphaj : integer - * numalphaj (integer) is the number of contributing factors. - gncdata : [cellidn, cellidm, cellidsj, alphasj] - * cellidn ((integer, ...)) is the cellid of the cell, :math:`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. This argument is an index variable, which - means that it should be treated as zero-based when working with FloPy - and Python. Flopy will automatically subtract one when loading index - variables and add one when writing index variables. - * cellidm ((integer, ...)) is the cellid of the connecting cell, - :math:`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. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - * cellidsj ((integer, ...)) 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. This argument is an index variable, - which means that it should be treated as zero-based when working with - FloPy and Python. Flopy will automatically subtract one when loading - index variables and add one when writing index variables. - * alphasj (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + is the number of contributing factors. + gncdata : [list] """ @@ -102,11 +43,8 @@ class ModflowGwfgnc(mfpackage.MFPackage): package_abbr = "gwfgnc" _package_type = "gnc" dfn_file_name = "gwf-gnc.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name print_input", @@ -205,21 +143,66 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfgnc defines a GNC package. + + Parameters + ---------- + parent_model_or_package + Parent_model_or_package that this package is a part of. Package is automatically + added to parent_model_or_package when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + print_input : keyword + keyword to indicate that the list of gnc information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + explicit : keyword + 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. + numgnc : integer + is the number of gnc entries. + numalphaj : integer + is the number of contributing factors. + gncdata : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__( parent_model_or_package, "gnc", filename, pname, loading_package, **kwargs ) - # set up variables self.print_input = self.build_mfdata("print_input", print_input) self.print_flows = self.build_mfdata("print_flows", print_flows) self.explicit = self.build_mfdata("explicit", explicit) self.numgnc = self.build_mfdata("numgnc", numgnc) self.numalphaj = self.build_mfdata("numalphaj", numalphaj) self.gncdata = self.build_mfdata("gncdata", gncdata) + self._init_complete = True -class GwfgncPackages(mfpackage.MFChildPackages): +class GwfgncPackages(MFChildPackages): """ GwfgncPackages is a container class for the ModflowGwfgnc class. @@ -232,6 +215,7 @@ class GwfgncPackages(mfpackage.MFChildPackages): append_package Adds a new ModflowGwfgnc package to the container. See ModflowGwfgnc init documentation for definition of parameters. + """ package_abbr = "gwfgncpackages" diff --git a/flopy/mf6/modflow/mfgwfgwe.py b/flopy/mf6/modflow/mfgwfgwe.py index d8f36865b5..1ef76e8e7d 100644 --- a/flopy/mf6/modflow/mfgwfgwe.py +++ b/flopy/mf6/modflow/mfgwfgwe.py @@ -1,47 +1,26 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage +# autogenerated file, do not modify -class ModflowGwfgwe(mfpackage.MFPackage): +from os import PathLike, curdir +from typing import Union + +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFPackage + + +class ModflowGwfgwe(MFPackage): """ - ModflowGwfgwe defines a gwfgwe package. + ModflowGwfgwe defines a GWFGWE package. Parameters ---------- - simulation : MFSimulation - Simulation that this package is a part of. Package is automatically - added to simulation when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - exgtype : - * is the exchange type (GWF-GWF or GWF-GWT). - exgmnamea : - * is the name of the first model that is part of this exchange. - exgmnameb : - * is the name of the second model that is part of this exchange. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. """ package_abbr = "gwfgwe" _package_type = "gwfgwe" dfn_file_name = "exg-gwfgwe.dfn" - - dfn = [ - [ - "header", - ], - ] + dfn = [["header"]] def __init__( self, @@ -54,17 +33,41 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfgwe defines a GWFGWE package. + + simulation : MFSimulation + Simulation that this package is a part of. Package is automatically + added to simulation when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + exgtype : str + The exchange type (GWF-GWF or GWF-GWT). + exgmnamea : str + The name of the first model that is part of this exchange. + exgmnameb : str + The name of the second model that is part of this exchange. + gwfmodelname1 : str + Name of first 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. + gwfmodelname2 : str + Name of second 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. + + """ + super().__init__( simulation, "gwfgwe", filename, pname, loading_package, **kwargs ) - # set up variables self.exgtype = exgtype - self.exgmnamea = exgmnamea - self.exgmnameb = exgmnameb - simulation.register_exchange_file(self) self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfgwf.py b/flopy/mf6/modflow/mfgwfgwf.py index 1df4a90453..4bace995fd 100644 --- a/flopy/mf6/modflow/mfgwfgwf.py +++ b/flopy/mf6/modflow/mfgwfgwf.py @@ -1,162 +1,109 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify -class ModflowGwfgwf(mfpackage.MFPackage): +from os import PathLike, curdir +from typing import Union + +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFPackage + + +class ModflowGwfgwf(MFPackage): """ - ModflowGwfgwf defines a gwfgwf package. + ModflowGwfgwf defines a GWFGWF package. Parameters ---------- - simulation : MFSimulation - Simulation that this package is a part of. Package is automatically - added to simulation when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - exgtype : - * is the exchange type (GWF-GWF or GWF-GWT). - exgmnamea : - * is the name of the first model that is part of this exchange. - exgmnameb : - * is the name of the second model that is part of this exchange. auxiliary : [string] - * auxiliary (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of GWF Exchange cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of exchange - entries will be echoed to the listing file immediately after it is - read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) 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. + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of gwf + exchange cells. + print_input : keyword + keyword to indicate that the list of exchange entries will be echoed to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + 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. cell_averaging : string - * cell_averaging (string) 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. - cvoptions : [dewatered] - * dewatered (string) 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. - newton : boolean - * newton (boolean) keyword that activates the Newton-Raphson - formulation for groundwater flow between connected, convertible - groundwater cells. Cells will not dry when this option is used. - xt3d : boolean - * xt3d (boolean) keyword that activates the XT3D formulation between - the cells connected with this GWF-GWF Exchange. - gncdata : {varname:data} or gncdata data - * Contains data for the gnc package. Data can be stored in a dictionary - containing data for the gnc package with variable names as keys and - package data as values. Data just for the gncdata variable is also - acceptable. See gnc package documentation for more information. - perioddata : {varname:data} or perioddata data - * Contains data for the mvr package. Data can be stored in a dictionary - containing data for the mvr package with variable names as keys and - package data as values. Data just for the perioddata variable is also - acceptable. See mvr package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - dev_interfacemodel_on : boolean - * dev_interfacemodel_on (boolean) activates the interface model - mechanism for calculating the coefficients at (and possibly near) the - exchange. This keyword should only be used for development purposes. + 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. + cvoptions : (variablecv, dewatered) + none + * variablecv : keyword + 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. + * dewatered : keyword + 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. + + newton : keyword + keyword that activates the newton-raphson formulation for groundwater flow + between connected, convertible groundwater cells. cells will not dry when this + option is used. + xt3d : keyword + keyword that activates the xt3d formulation between the cells connected with + this gwf-gwf exchange. + gncdata : record gnc6 filein gnc6_filename + Contains data for the gnc package. Data can be passed as a dictionary to the + gnc package with variable names as keys and package data as values. Data for + the gncdata variable is also acceptable. See gnc package documentation for more + information. + perioddata : record mvr6 filein mvr6_filename + Contains data for the mvr package. Data can be passed as a dictionary to the + mvr package with variable names as keys and package data as values. Data for + the perioddata variable is also acceptable. See mvr package documentation for + more information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + dev_interfacemodel_on : keyword + activates the interface model mechanism for calculating the coefficients at + (and possibly near) the exchange. this keyword should only be used for + development purposes. nexg : integer - * nexg (integer) keyword and integer value specifying the number of - GWF-GWF exchanges. - exchangedata : [cellidm1, cellidm2, ihc, cl1, cl2, hwva, aux, boundname] - * cellidm1 ((integer, ...)) 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. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - * cellidm2 ((integer, ...)) 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. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - * ihc (integer) 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. - * cl1 (double) is the distance between the center of cell 1 and the its - shared face with cell 2. - * cl2 (double) is the distance between the center of cell 2 and the its - shared face with cell 1. - * hwva (double) 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. - * aux (double) 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. - * boundname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + keyword and integer value specifying the number of gwf-gwf exchanges. + exchangedata : [list] """ - auxiliary = ListTemplateGenerator(("gwfgwf", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwfgwf", "options", "auxiliary")) gnc_filerecord = ListTemplateGenerator(("gwfgwf", "options", "gnc_filerecord")) mvr_filerecord = ListTemplateGenerator(("gwfgwf", "options", "mvr_filerecord")) obs_filerecord = ListTemplateGenerator(("gwfgwf", "options", "obs_filerecord")) @@ -164,12 +111,8 @@ class ModflowGwfgwf(mfpackage.MFPackage): package_abbr = "gwfgwf" _package_type = "gwfgwf" dfn_file_name = "exg-gwfgwf.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name auxiliary", @@ -337,8 +280,8 @@ class ModflowGwfgwf(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -488,17 +431,127 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfgwf defines a GWFGWF package. + + simulation : MFSimulation + Simulation that this package is a part of. Package is automatically + added to simulation when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + exgtype : str + The exchange type (GWF-GWF or GWF-GWT). + exgmnamea : str + The name of the first model that is part of this exchange. + exgmnameb : str + The name of the second model that is part of this exchange. + gwfmodelname1 : str + Name of first 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. + gwfmodelname2 : str + Name of second 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. + auxiliary : [string] + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of gwf + exchange cells. + print_input : keyword + keyword to indicate that the list of exchange entries will be echoed to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + 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. + cell_averaging : string + 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. + cvoptions : (variablecv, dewatered) + none + * variablecv : keyword + 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. + * dewatered : keyword + 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. + + newton : keyword + keyword that activates the newton-raphson formulation for groundwater flow + between connected, convertible groundwater cells. cells will not dry when this + option is used. + xt3d : keyword + keyword that activates the xt3d formulation between the cells connected with + this gwf-gwf exchange. + gncdata : record gnc6 filein gnc6_filename + Contains data for the gnc package. Data can be passed as a dictionary to the + gnc package with variable names as keys and package data as values. Data for + the gncdata variable is also acceptable. See gnc package documentation for more + information. + perioddata : record mvr6 filein mvr6_filename + Contains data for the mvr package. Data can be passed as a dictionary to the + mvr package with variable names as keys and package data as values. Data for + the perioddata variable is also acceptable. See mvr package documentation for + more information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + dev_interfacemodel_on : keyword + activates the interface model mechanism for calculating the coefficients at + (and possibly near) the exchange. this keyword should only be used for + development purposes. + nexg : integer + keyword and integer value specifying the number of gwf-gwf exchanges. + exchangedata : [list] + + """ + super().__init__( simulation, "gwfgwf", filename, pname, loading_package, **kwargs ) - # set up variables self.exgtype = exgtype - self.exgmnamea = exgmnamea - self.exgmnameb = exgmnameb - simulation.register_exchange_file(self) self.auxiliary = self.build_mfdata("auxiliary", auxiliary) @@ -527,4 +580,5 @@ def __init__( ) self.nexg = self.build_mfdata("nexg", nexg) self.exchangedata = self.build_mfdata("exchangedata", exchangedata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfgwt.py b/flopy/mf6/modflow/mfgwfgwt.py index 6acfb691cb..f70d0bfdc8 100644 --- a/flopy/mf6/modflow/mfgwfgwt.py +++ b/flopy/mf6/modflow/mfgwfgwt.py @@ -1,47 +1,26 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage +# autogenerated file, do not modify -class ModflowGwfgwt(mfpackage.MFPackage): +from os import PathLike, curdir +from typing import Union + +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFPackage + + +class ModflowGwfgwt(MFPackage): """ - ModflowGwfgwt defines a gwfgwt package. + ModflowGwfgwt defines a GWFGWT package. Parameters ---------- - simulation : MFSimulation - Simulation that this package is a part of. Package is automatically - added to simulation when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - exgtype : - * is the exchange type (GWF-GWF or GWF-GWT). - exgmnamea : - * is the name of the first model that is part of this exchange. - exgmnameb : - * is the name of the second model that is part of this exchange. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. """ package_abbr = "gwfgwt" _package_type = "gwfgwt" dfn_file_name = "exg-gwfgwt.dfn" - - dfn = [ - [ - "header", - ], - ] + dfn = [["header"]] def __init__( self, @@ -54,17 +33,41 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfgwt defines a GWFGWT package. + + simulation : MFSimulation + Simulation that this package is a part of. Package is automatically + added to simulation when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + exgtype : str + The exchange type (GWF-GWF or GWF-GWT). + exgmnamea : str + The name of the first model that is part of this exchange. + exgmnameb : str + The name of the second model that is part of this exchange. + gwfmodelname1 : str + Name of first 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. + gwfmodelname2 : str + Name of second 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. + + """ + super().__init__( simulation, "gwfgwt", filename, pname, loading_package, **kwargs ) - # set up variables self.exgtype = exgtype - self.exgmnamea = exgmnamea - self.exgmnameb = exgmnameb - simulation.register_exchange_file(self) self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfhfb.py b/flopy/mf6/modflow/mfgwfhfb.py index ec6e00dc13..ed820af732 100644 --- a/flopy/mf6/modflow/mfgwfhfb.py +++ b/flopy/mf6/modflow/mfgwfhfb.py @@ -1,68 +1,26 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfhfb(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfhfb(MFPackage): """ - ModflowGwfhfb defines a hfb package within a gwf6 model. + ModflowGwfhfb defines a HFB package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of horizontal - flow barriers will be written to the listing file immediately after - it is read. + print_input : keyword + keyword to indicate that the list of horizontal flow barriers will be written + to the listing file immediately after it is read. maxhfb : integer - * maxhfb (integer) integer value specifying the maximum number of - horizontal flow barriers that will be entered in this input file. The - value of MAXHFB is used to allocate memory for the horizontal flow - barriers. - stress_period_data : [cellid1, cellid2, hydchr] - * cellid1 ((integer, ...)) 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 numbers for the cell. The barrier is - located between cells designated as CELLID1 and CELLID2. For models - that use the DIS and DISV grid types, the layer number for CELLID1 - and CELLID2 must be the same. For all grid types, cells must be - horizontally adjacent or the program will terminate with an error. - This argument is an index variable, which means that it should be - treated as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * cellid2 ((integer, ...)) identifier for the second cell. See CELLID1 - for description of how to specify. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - * hydchr (double) is the hydraulic characteristic of the horizontal- - flow barrier. The hydraulic characteristic is the barrier hydraulic - conductivity divided by the width of the horizontal-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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the maximum number of horizontal flow barriers that + will be entered in this input file. the value of maxhfb is used to allocate + memory for the horizontal flow barriers. + stress_period_data : [list] """ @@ -72,11 +30,8 @@ class ModflowGwfhfb(mfpackage.MFPackage): package_abbr = "gwfhfb" _package_type = "hfb" dfn_file_name = "gwf-hfb.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name print_input", @@ -150,12 +105,42 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfhfb defines a HFB package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + print_input : keyword + keyword to indicate that the list of horizontal flow barriers will be written + to the listing file immediately after it is read. + maxhfb : integer + integer value specifying the maximum number of horizontal flow barriers that + will be entered in this input file. the value of maxhfb is used to allocate + memory for the horizontal flow barriers. + stress_period_data : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "hfb", filename, pname, loading_package, **kwargs) - # set up variables self.print_input = self.build_mfdata("print_input", print_input) self.maxhfb = self.build_mfdata("maxhfb", maxhfb) self.stress_period_data = self.build_mfdata( "stress_period_data", stress_period_data ) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfic.py b/flopy/mf6/modflow/mfgwfic.py index 0071c96465..dd6027daa3 100644 --- a/flopy/mf6/modflow/mfgwfic.py +++ b/flopy/mf6/modflow/mfgwfic.py @@ -1,47 +1,33 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfic(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfic(MFPackage): """ - ModflowGwfic defines a ic package within a gwf6 model. + ModflowGwfic defines a IC package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. - export_array_netcdf : boolean - * export_array_netcdf (boolean) keyword that specifies input griddata - arrays should be written to the model output netcdf file. - strt : [double] - * strt (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + strt : [double precision] + 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. """ @@ -49,11 +35,8 @@ class ModflowGwfic(mfpackage.MFPackage): package_abbr = "gwfic" _package_type = "ic" dfn_file_name = "gwf-ic.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name export_array_ascii", @@ -79,7 +62,7 @@ class ModflowGwfic(mfpackage.MFPackage): "reader readarray", "layered true", "netcdf true", - "default_value 1.0", + "default 1.0", ], ] @@ -94,9 +77,45 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfic defines a IC package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + strt : [double precision] + 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. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "ic", filename, pname, loading_package, **kwargs) - # set up variables self.export_array_ascii = self.build_mfdata( "export_array_ascii", export_array_ascii ) @@ -104,4 +123,5 @@ def __init__( "export_array_netcdf", export_array_netcdf ) self.strt = self.build_mfdata("strt", strt) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwflak.py b/flopy/mf6/modflow/mfgwflak.py index 8788e47440..02e5df9ea4 100644 --- a/flopy/mf6/modflow/mfgwflak.py +++ b/flopy/mf6/modflow/mfgwflak.py @@ -1,442 +1,133 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwflak(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwflak(MFPackage): """ - ModflowGwflak defines a lak package within a gwf6 model. + ModflowGwflak defines a LAK package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. auxiliary : [string] - * auxiliary (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of lake cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of lake - information will be written to the listing file immediately after it - is read. - print_stage : boolean - * print_stage (boolean) keyword to indicate that the list of lake - stages 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_STAGE is specified, then stages are - printed for the last time step of each stress period. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that lake flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - stage_filerecord : [stagefile] - * stagefile (string) name of the binary output file to write stage - information. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - package_convergence_filerecord : [package_convergence_filename] - * package_convergence_filename (string) name of the comma spaced values - output file to write package convergence information. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - mover : boolean - * mover (boolean) 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. - surfdep : double - * surfdep (double) 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. + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of lake + cells. + print_input : keyword + keyword to indicate that the list of lake information will be written to the + listing file immediately after it is read. + print_stage : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that lake flow terms will be written to the file specified + with 'budget fileout' in output control. + stage_filerecord : (stagefile) + * stagefile : string + name of the binary output file to write stage information. + + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + package_convergence_filerecord : (package_convergence_filename) + * package_convergence_filename : string + name of the comma spaced values output file to write package convergence + information. + + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. + surfdep : double precision + 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. maximum_iterations : integer - * maximum_iterations (integer) 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. - maximum_stage_change : double - * maximum_stage_change (double) real value that defines the lake stage - closure tolerance. By default, MAXIMUM_STAGE_CHANGE is equal to - :math:`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. - time_conversion : double - * time_conversion (double) 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. CONVTIME does not need to be specified if no lake - outlets are specified or TIME_UNITS are seconds. - length_conversion : double - * length_conversion (double) 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. + 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. + maximum_stage_change : double precision + real value that defines the lake stage closure tolerance. by default, + maximum_stage_change is equal to :math:`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. + time_conversion : double precision + 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. + convtime does not need to be specified if no lake outlets are specified or + time_units are seconds. + length_conversion : double precision + 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. nlakes : integer - * nlakes (integer) value specifying the number of lakes that will be - simulated for all stress periods. + value specifying the number of lakes that will be simulated for all stress + periods. noutlets : integer - * noutlets (integer) 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. + 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. ntables : integer - * ntables (integer) 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. - packagedata : [ifno, strt, nlakeconn, aux, boundname] - * ifno (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * strt (double) real value that defines the starting stage for the - lake. - * nlakeconn (integer) 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. - * aux (double) 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. - * boundname (string) 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. - connectiondata : [ifno, iconn, cellid, claktype, bedleak, belev, telev, - connlen, connwidth] - * ifno (integer) 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. This argument is an index variable, which means that it - should be treated as zero-based when working with FloPy and Python. - Flopy will automatically subtract one when loading index variables - and add one when writing index variables. - * iconn (integer) 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. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * claktype (string) 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 - :math:`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 :math:`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 :math:`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 :math:`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. - * bedleak (string) 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. - * belev (double) 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. - * telev (double) 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. - * connlen (double) 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. - * connwidth (double) 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. - tables : [ifno, tab6_filename] - * ifno (integer) 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. This argument is an index variable, which means that it - should be treated as zero-based when working with FloPy and Python. - Flopy will automatically subtract one when loading index variables - and add one when writing index variables. - * tab6_filename (string) 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. - outlets : [outletno, lakein, lakeout, couttype, invert, width, rough, - slope] - * outletno (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * lakein (integer) 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. This argument is an index variable, which - means that it should be treated as zero-based when working with FloPy - and Python. Flopy will automatically subtract one when loading index - variables and add one when writing index variables. - * lakeout (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - * couttype (string) 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. - * invert (double) 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. - * width (double) 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. - * rough (double) 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. - * slope (double) 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. - perioddata : [number, laksetting] - * number (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * laksetting (keystring) 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. - status : [string] - * status (string) keyword option to define lake status. STATUS - can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is - ACTIVE. - stage : [string] - * stage (string) 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. - rainfall : [string] - * rainfall (string) real or character value that defines the - rainfall rate :math:`(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. - evaporation : [string] - * evaporation (string) real or character value that defines the - maximum evaporation rate :math:`(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. - runoff : [string] - * runoff (string) real or character value that defines the - runoff rate :math:`(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. - inflow : [string] - * inflow (string) real or character value that defines the - volumetric inflow rate :math:`(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. - withdrawal : [string] - * withdrawal (string) real or character value that defines the - maximum withdrawal rate :math:`(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. - rate : [string] - * rate (string) 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. - invert : [string] - * invert (string) 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. - width : [string] - * width (string) 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. - slope : [string] - * slope (string) 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. - rough : [string] - * rough (string) 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. - auxiliaryrecord : [auxname, auxval] - * auxname (string) 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. - * auxval (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + packagedata : [list] + connectiondata : [list] + tables : [list] + outlets : [list] + perioddata : list """ - auxiliary = ListTemplateGenerator(("gwf6", "lak", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwf6", "lak", "options", "auxiliary")) stage_filerecord = ListTemplateGenerator( ("gwf6", "lak", "options", "stage_filerecord") ) @@ -461,7 +152,6 @@ class ModflowGwflak(mfpackage.MFPackage): package_abbr = "gwflak" _package_type = "lak" dfn_file_name = "gwf-lak.dfn" - dfn = [ ["header", "multi-package", "package-type advanced-stress-package"], [ @@ -688,8 +378,8 @@ class ModflowGwflak(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -834,8 +524,7 @@ class ModflowGwflak(mfpackage.MFPackage): [ "block connectiondata", "name connectiondata", - "type recarray ifno iconn cellid claktype bedleak belev telev " - "connlen connwidth", + "type recarray ifno iconn cellid claktype bedleak belev telev connlen connwidth", "shape (sum(nlakeconn))", "reader urword", ], @@ -1087,8 +776,7 @@ class ModflowGwflak(mfpackage.MFPackage): [ "block period", "name laksetting", - "type keystring status stage rainfall evaporation runoff inflow " - "withdrawal rate invert width slope rough auxiliaryrecord", + "type keystring status stage rainfall evaporation runoff inflow withdrawal rate invert width slope rough auxiliaryrecord", "shape", "tagged false", "in_record true", @@ -1285,9 +973,126 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwflak defines a LAK package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + auxiliary : [string] + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of lake + cells. + print_input : keyword + keyword to indicate that the list of lake information will be written to the + listing file immediately after it is read. + print_stage : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that lake flow terms will be written to the file specified + with 'budget fileout' in output control. + stage_filerecord : record + budget_filerecord : record + budgetcsv_filerecord : record + package_convergence_filerecord : record + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. + surfdep : double precision + 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. + maximum_iterations : integer + 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. + maximum_stage_change : double precision + real value that defines the lake stage closure tolerance. by default, + maximum_stage_change is equal to :math:`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. + time_conversion : double precision + 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. + convtime does not need to be specified if no lake outlets are specified or + time_units are seconds. + length_conversion : double precision + 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. + nlakes : integer + value specifying the number of lakes that will be simulated for all stress + periods. + noutlets : integer + 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. + ntables : integer + 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. + packagedata : [list] + connectiondata : [list] + tables : [list] + outlets : [list] + perioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "lak", filename, pname, loading_package, **kwargs) - # set up variables self.auxiliary = self.build_mfdata("auxiliary", auxiliary) self.boundnames = self.build_mfdata("boundnames", boundnames) self.print_input = self.build_mfdata("print_input", print_input) @@ -1332,4 +1137,5 @@ def __init__( self.tables = self.build_mfdata("tables", tables) self.outlets = self.build_mfdata("outlets", outlets) self.perioddata = self.build_mfdata("perioddata", perioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfmaw.py b/flopy/mf6/modflow/mfgwfmaw.py index f08c01506e..171d28c23b 100644 --- a/flopy/mf6/modflow/mfgwfmaw.py +++ b/flopy/mf6/modflow/mfgwfmaw.py @@ -1,370 +1,129 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfmaw(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfmaw(MFPackage): """ - ModflowGwfmaw defines a maw package within a gwf6 model. + ModflowGwfmaw defines a MAW package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. auxiliary : [string] - * auxiliary (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of multi-aquifer well cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of multi- - aquifer well information will be written to the listing file - immediately after it is read. - print_head : boolean - * print_head (boolean) keyword to indicate that the list of multi- - aquifer well heads 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_HEAD is specified, - then heads are printed for the last time step of each stress period. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that multi-aquifer well flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - head_filerecord : [headfile] - * headfile (string) name of the binary output file to write head - information. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - no_well_storage : boolean - * no_well_storage (boolean) keyword that deactivates inclusion of well - storage contributions to the multi-aquifer well package continuity - equation. - flow_correction : boolean - * flow_correction (boolean) 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. - flowing_wells : boolean - * flowing_wells (boolean) keyword that activates the flowing wells - option for the multi-aquifer well package. - shutdown_theta : double - * shutdown_theta (double) 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. - shutdown_kappa : double - * shutdown_kappa (double) 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. - mfrcsv_filerecord : [mfrcsvfile] - * mfrcsvfile (string) 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. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - mover : boolean - * mover (boolean) 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. + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of multi- + aquifer well cells. + print_input : keyword + keyword to indicate that the list of multi-aquifer well information will be + written to the listing file immediately after it is read. + print_head : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that multi-aquifer well flow terms will be written to the + file specified with 'budget fileout' in output control. + head_filerecord : (headfile) + * headfile : string + name of the binary output file to write head information. + + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + no_well_storage : keyword + keyword that deactivates inclusion of well storage contributions to the multi- + aquifer well package continuity equation. + flow_correction : keyword + 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. + flowing_wells : keyword + keyword that activates the flowing wells option for the multi-aquifer well + package. + shutdown_theta : double precision + 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. + shutdown_kappa : double precision + 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. + mfrcsv_filerecord : (mfrcsvfile) + * mfrcsvfile : string + 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. + + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. nmawwells : integer - * nmawwells (integer) integer value specifying the number of multi- - aquifer wells that will be simulated for all stress periods. - packagedata : [ifno, radius, bottom, strt, condeqn, ngwfnodes, aux, - boundname] - * ifno (integer) 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. This argument is an index variable, - which means that it should be treated as zero-based when working with - FloPy and Python. Flopy will automatically subtract one when loading - index variables and add one when writing index variables. - * radius (double) radius for the multi-aquifer well. The program will - terminate with an error if the radius is less than or equal to zero. - * bottom (double) bottom elevation of the multi-aquifer well. If - CONDEQN is SPECIFIED, THIEM, SKIN, or COMPOSITE, 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. - * strt (double) 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. - * condeqn (string) 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. - * ngwfnodes (integer) integer value that defines the number of GWF - nodes connected to this (IFNO) multi-aquifer well. NGWFNODES must be - greater than zero. - * aux (double) 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. - * boundname (string) 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. - connectiondata : [ifno, icon, cellid, scrn_top, scrn_bot, hk_skin, - radius_skin] - * ifno (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * icon (integer) 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. This argument is an index variable, which means that it should - be treated as zero-based when working with FloPy and Python. Flopy - will automatically subtract one when loading index variables and add - one when writing index variables. - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * scrn_top (double) value that defines the top elevation of the screen - for the multi-aquifer well connection. If CONDEQN is SPECIFIED, - THIEM, SKIN, or COMPOSITE, 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. - * scrn_bot (double) value that defines the bottom elevation of the - screen for the multi-aquifer well connection. If CONDEQN is - SPECIFIED, THIEM, SKIN, or COMPOSITE, 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. - * hk_skin (double) 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. - * radius_skin (double) 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. - perioddata : [ifno, mawsetting] - * ifno (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - * mawsetting (keystring) line of information that is parsed into a - keyword and values. Keyword values that can be used to start the - MAWSETTING string include: STATUS, FLOWING_WELL, RATE, WELL_HEAD, - HEAD_LIMIT, SHUT_OFF, RATE_SCALING, and AUXILIARY. - status : [string] - * status (string) keyword option to define well status. STATUS - can be ACTIVE, INACTIVE, or CONSTANT. By default, STATUS is - ACTIVE. - flowing_wellrecord : [fwelev, fwcond, fwrlen] - * fwelev (double) elevation used to determine whether or not - the well is flowing. - * fwcond (double) 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). - * fwrlen (double) 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. - rate : [double] - * rate (double) 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. - well_head : [double] - * well_head (double) 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. - head_limit : [string] - * head_limit (string) 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 (Konikow et al., 2009) - 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'. - shutoffrecord : [minrate, maxrate] - * minrate (double) 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. - * maxrate (double) 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. - rate_scalingrecord : [pump_elevation, scaling_length] - * pump_elevation (double) 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. - * scaling_length (double) 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. - auxiliaryrecord : [auxname, auxval] - * auxname (string) 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. - * auxval (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the number of multi-aquifer wells that will be + simulated for all stress periods. + packagedata : [list] + connectiondata : list + perioddata : list """ - auxiliary = ListTemplateGenerator(("gwf6", "maw", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwf6", "maw", "options", "auxiliary")) head_filerecord = ListTemplateGenerator( ("gwf6", "maw", "options", "head_filerecord") ) @@ -387,7 +146,6 @@ class ModflowGwfmaw(mfpackage.MFPackage): package_abbr = "gwfmaw" _package_type = "maw" dfn_file_name = "gwf-maw.dfn" - dfn = [ ["header", "multi-package", "package-type advanced-stress-package"], [ @@ -650,8 +408,8 @@ class ModflowGwfmaw(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -874,8 +632,7 @@ class ModflowGwfmaw(mfpackage.MFPackage): [ "block period", "name mawsetting", - "type keystring status flowing_wellrecord rate well_head " - "head_limit shutoffrecord rate_scalingrecord auxiliaryrecord", + "type keystring status flowing_wellrecord rate well_head head_limit shutoffrecord rate_scalingrecord auxiliaryrecord", "shape", "tagged false", "in_record true", @@ -1101,9 +858,120 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfmaw defines a MAW package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + auxiliary : [string] + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of multi- + aquifer well cells. + print_input : keyword + keyword to indicate that the list of multi-aquifer well information will be + written to the listing file immediately after it is read. + print_head : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that multi-aquifer well flow terms will be written to the + file specified with 'budget fileout' in output control. + head_filerecord : record + budget_filerecord : record + budgetcsv_filerecord : record + no_well_storage : keyword + keyword that deactivates inclusion of well storage contributions to the multi- + aquifer well package continuity equation. + flow_correction : keyword + 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. + flowing_wells : keyword + keyword that activates the flowing wells option for the multi-aquifer well + package. + shutdown_theta : double precision + 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. + shutdown_kappa : double precision + 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. + mfrcsv_filerecord : record + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. + nmawwells : integer + integer value specifying the number of multi-aquifer wells that will be + simulated for all stress periods. + packagedata : [list] + connectiondata : list + perioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "maw", filename, pname, loading_package, **kwargs) - # set up variables self.auxiliary = self.build_mfdata("auxiliary", auxiliary) self.boundnames = self.build_mfdata("boundnames", boundnames) self.print_input = self.build_mfdata("print_input", print_input) @@ -1138,4 +1006,5 @@ def __init__( self.packagedata = self.build_mfdata("packagedata", packagedata) self.connectiondata = self.build_mfdata("connectiondata", connectiondata) self.perioddata = self.build_mfdata("perioddata", perioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfmvr.py b/flopy/mf6/modflow/mfgwfmvr.py index 222a89e397..e83bb18b25 100644 --- a/flopy/mf6/modflow/mfgwfmvr.py +++ b/flopy/mf6/modflow/mfgwfmvr.py @@ -1,114 +1,50 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfmvr(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfmvr(MFPackage): """ - ModflowGwfmvr defines a mvr package within a gwf6 model. This package - can only be used to move water between packages within a single model. - To move water between models use ModflowMvr. + ModflowGwfmvr defines a MVR package. Parameters ---------- - parent_model_or_package : MFModel/MFPackage - Parent_model_or_package that this package is a part of. Package is automatically - added to parent_model_or_package when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of MVR - information will be written to the listing file immediately after it - is read. - print_flows : boolean - * print_flows (boolean) 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. - modelnames : boolean - * modelnames (boolean) 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. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. + print_input : keyword + keyword to indicate that the list of mvr information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + modelnames : keyword + 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. + budget_filerecord : (budgetfile) + * budgetfile : string + name of the output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + maxmvr : integer - * maxmvr (integer) integer value specifying the maximum number of water - mover entries that will specified for any stress period. + integer value specifying the maximum number of water mover entries that will + specified for any stress period. maxpackages : integer - * maxpackages (integer) integer value specifying the number of unique - packages that are included in this water mover input file. - packages : [mname, pname] - * mname (string) name of model containing the package. Model names are - assigned by the user in the simulation name file. - * pname (string) 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. - perioddata : [mname1, pname1, id1, mname2, pname2, id2, mvrtype, value] - * mname1 (string) name of model containing the package, PNAME1. - * pname1 (string) 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. - * id1 (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - * mname2 (string) name of model containing the package, PNAME2. - * pname2 (string) 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. - * id2 (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * mvrtype (string) 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, :math:`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. - * value (double) is the value to be used in the equation for - calculating the amount of water to move. For the "FACTOR" option, - VALUE is the :math:`\\alpha` factor. For the remaining options, VALUE - is the specified flow rate, :math:`Q_S`. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the number of unique packages that are included in + this water mover input file. + packages : [list] + perioddata : [list] """ @@ -123,11 +59,8 @@ class ModflowGwfmvr(mfpackage.MFPackage): package_abbr = "gwfmvr" _package_type = "mvr" dfn_file_name = "gwf-mvr.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name print_input", @@ -375,11 +308,56 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfmvr defines a MVR package. + + Parameters + ---------- + parent_model_or_package + Parent_model_or_package that this package is a part of. Package is automatically + added to parent_model_or_package when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + print_input : keyword + keyword to indicate that the list of mvr information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + modelnames : keyword + 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. + budget_filerecord : record + budgetcsv_filerecord : record + maxmvr : integer + integer value specifying the maximum number of water mover entries that will + specified for any stress period. + maxpackages : integer + integer value specifying the number of unique packages that are included in + this water mover input file. + packages : [list] + perioddata : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__( parent_model_or_package, "mvr", filename, pname, loading_package, **kwargs ) - # set up variables self.print_input = self.build_mfdata("print_input", print_input) self.print_flows = self.build_mfdata("print_flows", print_flows) self.modelnames = self.build_mfdata("modelnames", modelnames) @@ -393,10 +371,11 @@ def __init__( self.maxpackages = self.build_mfdata("maxpackages", maxpackages) self.packages = self.build_mfdata("packages", packages) self.perioddata = self.build_mfdata("perioddata", perioddata) + self._init_complete = True -class GwfmvrPackages(mfpackage.MFChildPackages): +class GwfmvrPackages(MFChildPackages): """ GwfmvrPackages is a container class for the ModflowGwfmvr class. @@ -409,6 +388,7 @@ class GwfmvrPackages(mfpackage.MFChildPackages): append_package Adds a new ModflowGwfmvr package to the container. See ModflowGwfmvr init documentation for definition of parameters. + """ package_abbr = "gwfmvrpackages" diff --git a/flopy/mf6/modflow/mfgwfnam.py b/flopy/mf6/modflow/mfgwfnam.py index eb4bcf6c06..011c484beb 100644 --- a/flopy/mf6/modflow/mfgwfnam.py +++ b/flopy/mf6/modflow/mfgwfnam.py @@ -1,82 +1,68 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfnam(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfnam(MFPackage): """ - ModflowGwfnam defines a nam package within a gwf6 model. + ModflowGwfnam defines a NAM package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. list : string - * list (string) 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". - print_input : boolean - * print_input (boolean) keyword to indicate that the list of all model - stress package information will be written to the listing file - immediately after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that all model package flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - newtonoptions : [under_relaxation] - * under_relaxation (string) 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. - nc_mesh2d_filerecord : [ncmesh2dfile] - * ncmesh2dfile (string) name of the netcdf ugrid layered mesh output - file. - nc_structured_filerecord : [ncstructfile] - * ncstructfile (string) name of the netcdf structured output file. - nc_filerecord : [netcdf_filename] - * netcdf_filename (string) defines a netcdf input file. - packages : [ftype, fname, pname] - * ftype (string) 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. - * fname (string) 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. - * pname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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'. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that all model package flow terms will be written to the + file specified with 'budget fileout' in output control. + newtonoptions : (newton, under_relaxation) + none + * newton : keyword + 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. + * under_relaxation : keyword + 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. + + nc_mesh2d_filerecord : (ncmesh2dfile) + netcdf layered mesh fileout record. + * ncmesh2dfile : string + name of the netcdf ugrid layered mesh output file. + + nc_structured_filerecord : (ncstructfile) + netcdf structured fileout record. + * ncstructfile : string + name of the netcdf structured output file. + + nc_filerecord : (netcdf_filename) + netcdf filerecord + * netcdf_filename : string + defines a netcdf input file. + + packages : list """ + newtonoptions = ListTemplateGenerator(("gwf6", "nam", "options", "newtonoptions")) nc_mesh2d_filerecord = ListTemplateGenerator( ("gwf6", "nam", "options", "nc_mesh2d_filerecord") ) @@ -88,11 +74,8 @@ class ModflowGwfnam(mfpackage.MFPackage): package_abbr = "gwfnam" _package_type = "nam" dfn_file_name = "gwf-nam.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name list", @@ -312,9 +295,67 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfnam defines a NAM package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + list : string + 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'. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that all model package flow terms will be written to the + file specified with 'budget fileout' in output control. + newtonoptions : (newton, under_relaxation) + none + * newton : keyword + 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. + * under_relaxation : keyword + 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. + + nc_mesh2d_filerecord : record + netcdf layered mesh fileout record. + nc_structured_filerecord : record + netcdf structured fileout record. + nc_filerecord : record + netcdf filerecord + packages : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "nam", filename, pname, loading_package, **kwargs) - # set up variables self.list = self.build_mfdata("list", list) self.print_input = self.build_mfdata("print_input", print_input) self.print_flows = self.build_mfdata("print_flows", print_flows) @@ -328,4 +369,5 @@ def __init__( ) self.nc_filerecord = self.build_mfdata("nc_filerecord", nc_filerecord) self.packages = self.build_mfdata("packages", packages) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfnpf.py b/flopy/mf6/modflow/mfgwfnpf.py index 95e18c702a..a66d49dd42 100644 --- a/flopy/mf6/modflow/mfgwfnpf.py +++ b/flopy/mf6/modflow/mfgwfnpf.py @@ -1,229 +1,224 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfnpf(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfnpf(MFPackage): """ - ModflowGwfnpf defines a npf package within a gwf6 model. + ModflowGwfnpf defines a NPF package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - save_flows : boolean - * save_flows (boolean) keyword to indicate that budget flow terms will - be written to the file specified with "BUDGET SAVE FILE" in Output - Control. - print_flows : boolean - * print_flows (boolean) 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. + save_flows : keyword + keyword to indicate that budget flow terms will be written to the file + specified with 'budget save file' in output control. + print_flows : keyword + 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. alternative_cell_averaging : string - * alternative_cell_averaging (string) 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. - thickstrt : boolean - * thickstrt (boolean) 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. - cvoptions : [dewatered] - * dewatered (string) 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. - perched : boolean - * perched (boolean) 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. - rewet_record : [wetfct, iwetit, ihdwet] - * wetfct (double) 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. - * iwetit (integer) 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. - * ihdwet (integer) 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). - xt3doptions : [rhs] - * rhs (string) 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. - save_specific_discharge : boolean - * save_specific_discharge (boolean) 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. - save_saturation : boolean - * save_saturation (boolean) 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. - k22overk : boolean - * k22overk (boolean) 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. - k33overk : boolean - * k33overk (boolean) 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. - perioddata : {varname:data} or tvk_perioddata data - * Contains data for the tvk package. Data can be stored in a dictionary - containing data for the tvk package with variable names as keys and - package data as values. Data just for the perioddata variable is also - acceptable. See tvk package documentation for more information. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. - export_array_netcdf : boolean - * export_array_netcdf (boolean) keyword that specifies input griddata - arrays should be written to the model output netcdf file. - dev_no_newton : boolean - * dev_no_newton (boolean) turn off Newton for unconfined cells - dev_omega : double - * dev_omega (double) set saturation omega value + 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. + thickstrt : keyword + 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. + cvoptions : (variablecv, dewatered) + none + * variablecv : keyword + 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. + * dewatered : keyword + 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. + + perched : keyword + 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. + rewet_record : (rewet, wetfct, iwetit, ihdwet) + * rewet : keyword + activates model rewetting. Rewetting is off by default. + * wetfct : double precision + 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. + * iwetit : integer + 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. + * ihdwet : integer + 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). + + xt3doptions : (xt3d, rhs) + none + * xt3d : keyword + 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. + * rhs : keyword + 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. + + save_specific_discharge : keyword + 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. + save_saturation : keyword + 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. + k22overk : keyword + 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. + k33overk : keyword + 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. + perioddata : record tvk6 filein tvk6_filename + Contains data for the tvk package. Data can be passed as a dictionary to the + tvk package with variable names as keys and package data as values. Data for + the perioddata variable is also acceptable. See tvk package documentation for + more information. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + dev_no_newton : keyword + turn off newton for unconfined cells + dev_omega : double precision + set saturation omega value icelltype : [integer] - * icelltype (integer) 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. - k : [double] - * k (double) 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. - k22 : [double] - * k22 (double) 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. - k33 : [double] - * k33 (double) 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. - angle1 : [double] - * angle1 (double) 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. - angle2 : [double] - * angle2 (double) 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. - angle3 : [double] - * angle3 (double) 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. - wetdry : [double] - * wetdry (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + k : [double precision] + 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. + k22 : [double precision] + 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. + k33 : [double precision] + 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. + angle1 : [double precision] + 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. + angle2 : [double precision] + 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. + angle3 : [double precision] + 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. + wetdry : [double precision] + 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. """ rewet_record = ListTemplateGenerator(("gwf6", "npf", "options", "rewet_record")) + xt3doptions = ListTemplateGenerator(("gwf6", "npf", "options", "xt3doptions")) tvk_filerecord = ListTemplateGenerator(("gwf6", "npf", "options", "tvk_filerecord")) icelltype = ArrayTemplateGenerator(("gwf6", "npf", "griddata", "icelltype")) k = ArrayTemplateGenerator(("gwf6", "npf", "griddata", "k")) @@ -236,11 +231,8 @@ class ModflowGwfnpf(mfpackage.MFPackage): package_abbr = "gwfnpf" _package_type = "npf" dfn_file_name = "gwf-npf.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name save_flows", @@ -411,8 +403,8 @@ class ModflowGwfnpf(mfpackage.MFPackage): "tagged true", "optional true", "construct_package tvk", - "construct_data tvk_perioddata", - "parameter_name perioddata", + "construct_data perioddata", + "parameter_name tvk_perioddata", ], [ "block options", @@ -487,7 +479,7 @@ class ModflowGwfnpf(mfpackage.MFPackage): "layered true", "netcdf true", "optional", - "default_value 0", + "default 0", ], [ "block griddata", @@ -499,7 +491,7 @@ class ModflowGwfnpf(mfpackage.MFPackage): "layered true", "netcdf true", "optional", - "default_value 1.0", + "default 1.0", ], [ "block griddata", @@ -602,9 +594,231 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfnpf defines a NPF package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + save_flows : keyword + keyword to indicate that budget flow terms will be written to the file + specified with 'budget save file' in output control. + print_flows : keyword + 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. + alternative_cell_averaging : string + 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. + thickstrt : keyword + 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. + cvoptions : (variablecv, dewatered) + none + * variablecv : keyword + 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. + * dewatered : keyword + 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. + + perched : keyword + 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. + rewet_record : (rewet, wetfct, iwetit, ihdwet) + * rewet : keyword + activates model rewetting. Rewetting is off by default. + * wetfct : double precision + 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. + * iwetit : integer + 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. + * ihdwet : integer + 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). + + xt3doptions : (xt3d, rhs) + none + * xt3d : keyword + 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. + * rhs : keyword + 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. + + save_specific_discharge : keyword + 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. + save_saturation : keyword + 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. + k22overk : keyword + 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. + k33overk : keyword + 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. + perioddata : record tvk6 filein tvk6_filename + Contains data for the tvk package. Data can be passed as a dictionary to the + tvk package with variable names as keys and package data as values. Data for + the perioddata variable is also acceptable. See tvk package documentation for + more information. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + dev_no_newton : keyword + turn off newton for unconfined cells + dev_omega : double precision + set saturation omega value + icelltype : [integer] + 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. + k : [double precision] + 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. + k22 : [double precision] + 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. + k33 : [double precision] + 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. + angle1 : [double precision] + 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. + angle2 : [double precision] + 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. + angle3 : [double precision] + 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. + wetdry : [double precision] + 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. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "npf", filename, pname, loading_package, **kwargs) - # set up variables self.save_flows = self.build_mfdata("save_flows", save_flows) self.print_flows = self.build_mfdata("print_flows", print_flows) self.alternative_cell_averaging = self.build_mfdata( @@ -641,4 +855,5 @@ def __init__( self.angle2 = self.build_mfdata("angle2", angle2) self.angle3 = self.build_mfdata("angle3", angle3) self.wetdry = self.build_mfdata("wetdry", wetdry) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfoc.py b/flopy/mf6/modflow/mfgwfoc.py index 28fdb17916..195321fdf6 100644 --- a/flopy/mf6/modflow/mfgwfoc.py +++ b/flopy/mf6/modflow/mfgwfoc.py @@ -1,93 +1,54 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfoc(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfoc(MFPackage): """ - ModflowGwfoc defines a oc package within a gwf6 model. + ModflowGwfoc defines a OC package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - head_filerecord : [headfile] - * headfile (string) name of the output file to write head information. - headprintrecord : [columns, width, digits, format] - * columns (integer) number of columns for writing data. - * width (integer) width for writing each number. - * digits (integer) number of digits to use for writing a number. - * format (string) write format can be EXPONENTIAL, FIXED, GENERAL, or - SCIENTIFIC. - saverecord : [rtype, ocsetting] - * rtype (string) type of information to save or print. Can be BUDGET or - HEAD. - * ocsetting (keystring) specifies the steps for which the data will be - saved. - all : [keyword] - * all (keyword) keyword to indicate save for all time steps in - period. - first : [keyword] - * first (keyword) 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. - last : [keyword] - * last (keyword) 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. - frequency : [integer] - * frequency (integer) 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. - steps : [integer] - * steps (integer) 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. - printrecord : [rtype, ocsetting] - * rtype (string) type of information to save or print. Can be BUDGET or - HEAD. - * ocsetting (keystring) specifies the steps for which the data will be - saved. - all : [keyword] - * all (keyword) keyword to indicate save for all time steps in - period. - first : [keyword] - * first (keyword) 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. - last : [keyword] - * last (keyword) 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. - frequency : [integer] - * frequency (integer) 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. - steps : [integer] - * steps (integer) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + budget_filerecord : (budgetfile) + * budgetfile : string + name of the output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + head_filerecord : (headfile) + * headfile : string + name of the output file to write head information. + + headprintrecord : (head, print_format) + * head : keyword + keyword to specify that record corresponds to head. + * print_format : keyword + keyword to specify format for printing to the listing file. + + saverecord : (save, rtype, ocsetting) + * save : keyword + keyword to indicate that information will be saved this stress period. + * rtype : string + type of information to save or print. Can be BUDGET or HEAD. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + + printrecord : (print, rtype, ocsetting) + * print : keyword + keyword to indicate that information will be printed this stress period. + * rtype : string + type of information to save or print. Can be BUDGET or HEAD. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + """ @@ -108,11 +69,8 @@ class ModflowGwfoc(mfpackage.MFPackage): package_abbr = "gwfoc" _package_type = "oc" dfn_file_name = "gwf-oc.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name budget_filerecord", @@ -408,9 +366,55 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfoc defines a OC package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + budget_filerecord : record + budgetcsv_filerecord : record + head_filerecord : record + headprintrecord : (head, print_format) + * head : keyword + keyword to specify that record corresponds to head. + * print_format : keyword + keyword to specify format for printing to the listing file. + + saverecord : (save, rtype, ocsetting) + * save : keyword + keyword to indicate that information will be saved this stress period. + * rtype : string + type of information to save or print. Can be BUDGET or HEAD. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + + printrecord : (print, rtype, ocsetting) + * print : keyword + keyword to indicate that information will be printed this stress period. + * rtype : string + type of information to save or print. Can be BUDGET or HEAD. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "oc", filename, pname, loading_package, **kwargs) - # set up variables self.budget_filerecord = self.build_mfdata( "budget_filerecord", budget_filerecord ) @@ -421,4 +425,5 @@ def __init__( self.headprintrecord = self.build_mfdata("headprintrecord", headprintrecord) self.saverecord = self.build_mfdata("saverecord", saverecord) self.printrecord = self.build_mfdata("printrecord", printrecord) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfprt.py b/flopy/mf6/modflow/mfgwfprt.py index 697e528d38..b986116ecc 100644 --- a/flopy/mf6/modflow/mfgwfprt.py +++ b/flopy/mf6/modflow/mfgwfprt.py @@ -1,47 +1,26 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage +# autogenerated file, do not modify -class ModflowGwfprt(mfpackage.MFPackage): +from os import PathLike, curdir +from typing import Union + +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFPackage + + +class ModflowGwfprt(MFPackage): """ - ModflowGwfprt defines a gwfprt package. + ModflowGwfprt defines a GWFPRT package. Parameters ---------- - simulation : MFSimulation - Simulation that this package is a part of. Package is automatically - added to simulation when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - exgtype : - * is the exchange type (GWF-GWF or GWF-GWT). - exgmnamea : - * is the name of the first model that is part of this exchange. - exgmnameb : - * is the name of the second model that is part of this exchange. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. """ package_abbr = "gwfprt" _package_type = "gwfprt" dfn_file_name = "exg-gwfprt.dfn" - - dfn = [ - [ - "header", - ], - ] + dfn = [["header"]] def __init__( self, @@ -54,17 +33,41 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfprt defines a GWFPRT package. + + simulation : MFSimulation + Simulation that this package is a part of. Package is automatically + added to simulation when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + exgtype : str + The exchange type (GWF-GWF or GWF-GWT). + exgmnamea : str + The name of the first model that is part of this exchange. + exgmnameb : str + The name of the second model that is part of this exchange. + gwfmodelname1 : str + Name of first 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. + gwfmodelname2 : str + Name of second 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. + + """ + super().__init__( simulation, "gwfprt", filename, pname, loading_package, **kwargs ) - # set up variables self.exgtype = exgtype - self.exgmnamea = exgmnamea - self.exgmnameb = exgmnameb - simulation.register_exchange_file(self) self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfrch.py b/flopy/mf6/modflow/mfgwfrch.py index 20ae02cf53..7bccf43a27 100644 --- a/flopy/mf6/modflow/mfgwfrch.py +++ b/flopy/mf6/modflow/mfgwfrch.py @@ -1,114 +1,67 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfrch(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfrch(MFPackage): """ - ModflowGwfrch defines a rch package within a gwf6 model. + ModflowGwfrch defines a RCH package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - fixed_cell : boolean - * fixed_cell (boolean) indicates that recharge will not be reassigned - to a cell underlying the cell specified in the list if the specified - cell is inactive. + fixed_cell : keyword + indicates that recharge will not be reassigned to a cell underlying the cell + specified in the list if the specified cell is inactive. auxiliary : [string] - * auxiliary (string) 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. + 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. auxmultname : string - * auxmultname (string) name of auxiliary variable to be used as - multiplier of recharge. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of recharge cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of recharge - information will be written to the listing file immediately after it - is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that recharge flow terms - will be written to the file specified with "BUDGET FILEOUT" in Output - Control. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. + name of auxiliary variable to be used as multiplier of recharge. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + recharge cells. + print_input : keyword + keyword to indicate that the list of recharge information will be written to + the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that recharge flow terms will be written to the file + specified with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. maxbound : integer - * maxbound (integer) integer value specifying the maximum number of - recharge cells cells that will be specified for use during any stress - period. - stress_period_data : [cellid, recharge, aux, boundname] - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * recharge (double) is the recharge flux rate (:math:`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. - * aux (double) 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. - * boundname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the maximum number of recharge cells cells that will + be specified for use during any stress period. + stress_period_data : [list] """ - auxiliary = ListTemplateGenerator(("gwf6", "rch", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwf6", "rch", "options", "auxiliary")) ts_filerecord = ListTemplateGenerator(("gwf6", "rch", "options", "ts_filerecord")) obs_filerecord = ListTemplateGenerator(("gwf6", "rch", "options", "obs_filerecord")) stress_period_data = ListTemplateGenerator( @@ -117,7 +70,6 @@ class ModflowGwfrch(mfpackage.MFPackage): package_abbr = "gwfrch" _package_type = "rch" dfn_file_name = "gwf-rch.dfn" - dfn = [ ["header", "multi-package", "package-type stress-package"], [ @@ -227,8 +179,8 @@ class ModflowGwfrch(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -339,9 +291,75 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfrch defines a RCH package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + fixed_cell : keyword + indicates that recharge will not be reassigned to a cell underlying the cell + specified in the list if the specified cell is inactive. + auxiliary : [string] + 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. + auxmultname : string + name of auxiliary variable to be used as multiplier of recharge. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + recharge cells. + print_input : keyword + keyword to indicate that the list of recharge information will be written to + the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that recharge flow terms will be written to the file + specified with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + maxbound : integer + integer value specifying the maximum number of recharge cells cells that will + be specified for use during any stress period. + stress_period_data : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "rch", filename, pname, loading_package, **kwargs) - # set up variables self.fixed_cell = self.build_mfdata("fixed_cell", fixed_cell) self.auxiliary = self.build_mfdata("auxiliary", auxiliary) self.auxmultname = self.build_mfdata("auxmultname", auxmultname) @@ -361,4 +379,5 @@ def __init__( self.stress_period_data = self.build_mfdata( "stress_period_data", stress_period_data ) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfrcha.py b/flopy/mf6/modflow/mfgwfrcha.py index a64a8cf5aa..db7e55db8b 100644 --- a/flopy/mf6/modflow/mfgwfrcha.py +++ b/flopy/mf6/modflow/mfgwfrcha.py @@ -1,114 +1,88 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfrcha(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfrcha(MFPackage): """ - ModflowGwfrcha defines a rcha package within a gwf6 model. + ModflowGwfrcha defines a RCHA package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - readasarrays : boolean - * readasarrays (boolean) 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. - fixed_cell : boolean - * fixed_cell (boolean) indicates that recharge will not be reassigned - to a cell underlying the cell specified in the list if the specified - cell is inactive. + readasarrays : keyword + 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. + fixed_cell : keyword + indicates that recharge will not be reassigned to a cell underlying the cell + specified in the list if the specified cell is inactive. auxiliary : [string] - * auxiliary (string) 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. + 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. auxmultname : string - * auxmultname (string) name of auxiliary variable to be used as - multiplier of recharge. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of recharge - information will be written to the listing file immediately after it - is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that recharge flow terms - will be written to the file specified with "BUDGET FILEOUT" in Output - Control. - timearrayseries : {varname:data} or tas_array data - * Contains data for the tas package. Data can be stored in a dictionary - containing data for the tas package with variable names as keys and - package data as values. Data just for the timearrayseries variable is - also acceptable. See tas package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - export_array_netcdf : boolean - * export_array_netcdf (boolean) keyword that specifies input griddata - arrays should be written to the model output netcdf file. + name of auxiliary variable to be used as multiplier of recharge. + print_input : keyword + keyword to indicate that the list of recharge information will be written to + the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that recharge flow terms will be written to the file + specified with 'budget fileout' in output control. + timearrayseries : record tas6 filein tas6_filename + Contains data for the tas package. Data can be passed as a dictionary to the + tas package with variable names as keys and package data as values. Data for + the timearrayseries variable is also acceptable. See tas package documentation + for more information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. irch : [integer] - * irch (integer) 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. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - recharge : [double] - * recharge (double) is the recharge flux rate (:math:`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). - aux : [double] - * aux (double) 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 a value of zero is assigned. If the value - specified here for the auxiliary variable is the same as auxmultname, - then the recharge array will be multiplied by this array. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + recharge : [double precision] + is the recharge flux rate (:math:`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). + aux : [double precision] + 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 a value of zero is + assigned. if the value specified here for the auxiliary variable is the same + as auxmultname, then the recharge array will be multiplied by this array. """ - auxiliary = ListTemplateGenerator(("gwf6", "rcha", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwf6", "rcha", "options", "auxiliary")) tas_filerecord = ListTemplateGenerator( ("gwf6", "rcha", "options", "tas_filerecord") ) @@ -121,7 +95,6 @@ class ModflowGwfrcha(mfpackage.MFPackage): package_abbr = "gwfrcha" _package_type = "rcha" dfn_file_name = "gwf-rcha.dfn" - dfn = [ ["header", "multi-package", "package-type stress-package"], [ @@ -131,7 +104,7 @@ class ModflowGwfrcha(mfpackage.MFPackage): "shape", "reader urword", "optional false", - "default_value True", + "default True", ], [ "block options", @@ -190,8 +163,8 @@ class ModflowGwfrcha(mfpackage.MFPackage): "tagged true", "optional true", "construct_package tas", - "construct_data tas_array", - "parameter_name timearrayseries", + "construct_data timearrayseries", + "parameter_name tas_array", ], [ "block options", @@ -232,8 +205,8 @@ class ModflowGwfrcha(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -292,7 +265,7 @@ class ModflowGwfrcha(mfpackage.MFPackage): "shape (ncol*nrow; ncpl)", "reader readarray", "time_series true", - "default_value 1.e-3", + "default 1.e-3", ], [ "block period", @@ -321,15 +294,102 @@ def __init__( observations=None, export_array_netcdf=None, irch=None, - recharge=1.0e-3, + recharge=0.001, aux=None, filename=None, pname=None, **kwargs, ): + """ + ModflowGwfrcha defines a RCHA package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + readasarrays : keyword + 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. + fixed_cell : keyword + indicates that recharge will not be reassigned to a cell underlying the cell + specified in the list if the specified cell is inactive. + auxiliary : [string] + 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. + auxmultname : string + name of auxiliary variable to be used as multiplier of recharge. + print_input : keyword + keyword to indicate that the list of recharge information will be written to + the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that recharge flow terms will be written to the file + specified with 'budget fileout' in output control. + timearrayseries : record tas6 filein tas6_filename + Contains data for the tas package. Data can be passed as a dictionary to the + tas package with variable names as keys and package data as values. Data for + the timearrayseries variable is also acceptable. See tas package documentation + for more information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + irch : [integer] + 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. + recharge : [double precision] + is the recharge flux rate (:math:`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). + aux : [double precision] + 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 a value of zero is + assigned. if the value specified here for the auxiliary variable is the same + as auxmultname, then the recharge array will be multiplied by this array. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "rcha", filename, pname, loading_package, **kwargs) - # set up variables self.readasarrays = self.build_mfdata("readasarrays", readasarrays) self.fixed_cell = self.build_mfdata("fixed_cell", fixed_cell) self.auxiliary = self.build_mfdata("auxiliary", auxiliary) @@ -351,4 +411,5 @@ def __init__( self.irch = self.build_mfdata("irch", irch) self.recharge = self.build_mfdata("recharge", recharge) self.aux = self.build_mfdata("aux", aux) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfriv.py b/flopy/mf6/modflow/mfgwfriv.py index 4587596a75..eb0f157429 100644 --- a/flopy/mf6/modflow/mfgwfriv.py +++ b/flopy/mf6/modflow/mfgwfriv.py @@ -1,120 +1,69 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfriv(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfriv(MFPackage): """ - ModflowGwfriv defines a riv package within a gwf6 model. + ModflowGwfriv defines a RIV package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. auxiliary : [string] - * auxiliary (string) 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. + 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. auxmultname : string - * auxmultname (string) name of auxiliary variable to be used as - multiplier of riverbed conductance. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of river cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of river - information will be written to the listing file immediately after it - is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that river flow terms will - be written to the file specified with "BUDGET FILEOUT" in Output - Control. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - mover : boolean - * mover (boolean) 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. + name of auxiliary variable to be used as multiplier of riverbed conductance. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of river + cells. + print_input : keyword + keyword to indicate that the list of river information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that river flow terms will be written to the file specified + with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. maxbound : integer - * maxbound (integer) integer value specifying the maximum number of - rivers cells that will be specified for use during any stress period. - stress_period_data : [cellid, stage, cond, rbot, aux, boundname] - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * stage (double) 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. - * cond (double) 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. - * rbot (double) 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. - * aux (double) 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. - * boundname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the maximum number of rivers cells that will be + specified for use during any stress period. + stress_period_data : [list] """ - auxiliary = ListTemplateGenerator(("gwf6", "riv", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwf6", "riv", "options", "auxiliary")) ts_filerecord = ListTemplateGenerator(("gwf6", "riv", "options", "ts_filerecord")) obs_filerecord = ListTemplateGenerator(("gwf6", "riv", "options", "obs_filerecord")) stress_period_data = ListTemplateGenerator( @@ -123,7 +72,6 @@ class ModflowGwfriv(mfpackage.MFPackage): package_abbr = "gwfriv" _package_type = "riv" dfn_file_name = "gwf-riv.dfn" - dfn = [ ["header", "multi-package", "package-type stress-package"], [ @@ -225,8 +173,8 @@ class ModflowGwfriv(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -365,9 +313,77 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfriv defines a RIV package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + auxiliary : [string] + 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. + auxmultname : string + name of auxiliary variable to be used as multiplier of riverbed conductance. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of river + cells. + print_input : keyword + keyword to indicate that the list of river information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that river flow terms will be written to the file specified + with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. + maxbound : integer + integer value specifying the maximum number of rivers cells that will be + specified for use during any stress period. + stress_period_data : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "riv", filename, pname, loading_package, **kwargs) - # set up variables self.auxiliary = self.build_mfdata("auxiliary", auxiliary) self.auxmultname = self.build_mfdata("auxmultname", auxmultname) self.boundnames = self.build_mfdata("boundnames", boundnames) @@ -387,4 +403,5 @@ def __init__( self.stress_period_data = self.build_mfdata( "stress_period_data", stress_period_data ) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfsfr.py b/flopy/mf6/modflow/mfgwfsfr.py index 0f88a1196b..cd365dced0 100644 --- a/flopy/mf6/modflow/mfgwfsfr.py +++ b/flopy/mf6/modflow/mfgwfsfr.py @@ -1,482 +1,141 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfsfr(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfsfr(MFPackage): """ - ModflowGwfsfr defines a sfr package within a gwf6 model. + ModflowGwfsfr defines a SFR package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - storage : boolean - * storage (boolean) keyword that activates storage contributions to the - stream-flow routing package continuity equation. + storage : keyword + keyword that activates storage contributions to the stream-flow routing package + continuity equation. auxiliary : [string] - * auxiliary (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of stream reach cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of stream - reach information will be written to the listing file immediately - after it is read. - print_stage : boolean - * print_stage (boolean) keyword to indicate that the list of stream - reach stages 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_STAGE is specified, then stages - are printed for the last time step of each stress period. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that stream reach flow terms - will be written to the file specified with "BUDGET FILEOUT" in Output - Control. - stage_filerecord : [stagefile] - * stagefile (string) name of the binary output file to write stage - information. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - package_convergence_filerecord : [package_convergence_filename] - * package_convergence_filename (string) name of the comma spaced values - output file to write package convergence information. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - mover : boolean - * mover (boolean) 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. + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of stream + reach cells. + print_input : keyword + keyword to indicate that the list of stream reach information will be written + to the listing file immediately after it is read. + print_stage : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that stream reach flow terms will be written to the file + specified with 'budget fileout' in output control. + stage_filerecord : (stagefile) + * stagefile : string + name of the binary output file to write stage information. + + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + package_convergence_filerecord : (package_convergence_filename) + * package_convergence_filename : string + name of the comma spaced values output file to write package convergence + information. + + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. maximum_picard_iterations : integer - * maximum_picard_iterations (integer) 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. + 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. maximum_iterations : integer - * maximum_iterations (integer) 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. - maximum_depth_change : double - * maximum_depth_change (double) real value that defines the depth - closure tolerance. By default, MAXIMUM_DEPTH_CHANGE is equal to - :math:`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. - unit_conversion : double - * unit_conversion (double) real value that is used to convert user- - specified Manning's roughness coefficients from seconds per - meters:math:`^{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. - length_conversion : double - * length_conversion (double) 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. - time_conversion : double - * time_conversion (double) 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. - dev_storage_weight : double - * dev_storage_weight (double) real number value that defines the time - weighting factor used to calculate the change in channel storage. - STORAGE_WEIGHT must have a value between 0.5 and 1. Default - STORAGE_WEIGHT value is 1. + 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. + maximum_depth_change : double precision + real value that defines the depth closure tolerance. by default, + maximum_depth_change is equal to :math:`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. + unit_conversion : double precision + real value that is used to convert user-specified manning's roughness + coefficients from seconds per meters:math:`^{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. + length_conversion : double precision + 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. + time_conversion : double precision + 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. + dev_storage_weight : double precision + real number value that defines the time weighting factor used to calculate the + change in channel storage. storage_weight must have a value between 0.5 and 1. + default storage_weight value is 1. nreaches : integer - * nreaches (integer) integer value specifying the number of stream - reaches. There must be NREACHES entries in the PACKAGEDATA block. - packagedata : [ifno, cellid, rlen, rwid, rgrd, rtp, rbth, rhk, man, ncon, - ustrf, ndv, aux, boundname] - * ifno (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * rlen (double) real value that defines the reach length. RLEN must be - greater than zero. - * rwid (double) real value that defines the reach width. RWID must be - greater than zero. - * rgrd (double) real value that defines the stream gradient (slope) - across the reach. RGRD must be greater than zero. - * rtp (double) real value that defines the bottom elevation of the - reach. - * rbth (double) 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. - * rhk (double) 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. - * man (string) 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. - * ncon (integer) 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. - * ustrf (double) 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. - * ndv (integer) integer value that defines the number of downstream - diversions for the reach. - * aux (double) 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. - * boundname (string) 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. - crosssections : [ifno, tab6_filename] - * ifno (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - * tab6_filename (string) 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. - connectiondata : [ifno, ic] - * ifno (integer) 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. This argument is an index variable, which means that it - should be treated as zero-based when working with FloPy and Python. - Flopy will automatically subtract one when loading index variables - and add one when writing index variables. - * ic (double_precision) 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. This argument is an index variable, which means - that it should be treated as zero-based when working with FloPy and - Python. Flopy will automatically subtract one when loading index - variables and add one when writing index variables. - diversions : [ifno, idv, iconr, cprior] - * ifno (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * idv (integer) 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. This argument is - an index variable, which means that it should be treated as zero- - based when working with FloPy and Python. Flopy will automatically - subtract one when loading index variables and add one when writing - index variables. - * iconr (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - * cprior (string) 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 (:math:`Q_{DS}`); in - this case, 0.0 :math:`\\le` DIVFLOW :math:`\\le` 1.0. (2) CPRIOR = - 'EXCESS', a diversion is made only if :math:`Q_{DS}` for reach IFNO - exceeds the value of DIVFLOW. If this occurs, then the quantity of - water diverted is the excess flow (:math:`Q_{DS} -` DIVFLOW) and - :math:`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 :math:`Q_{DS}` - in reach IFNO is less than the specified diversion flow DIVFLOW, no - water is diverted from reach IFNO. If :math:`Q_{DS}` in reach IFNO is - greater than or equal to DIVFLOW, DIVFLOW is diverted and - :math:`Q_{DS}` is set to the remainder (:math:`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 :math:`Q_{DS}` in reach - IFNO is greater than or equal to the specified diversion flow - DIVFLOW, :math:`Q_{DS}` is reduced by DIVFLOW. If :math:`Q_{DS}` in - reach IFNO is less than DIVFLOW, DIVFLOW is set to :math:`Q_{DS}` and - there will be no flow available for reaches connected to downstream - end of reach IFNO. - initialstages : [ifno, initialstage] - * ifno (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - * initialstage (double) 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. - perioddata : [ifno, sfrsetting] - * ifno (integer) 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. This argument - is an index variable, which means that it should be treated as zero- - based when working with FloPy and Python. Flopy will automatically - subtract one when loading index variables and add one when writing - index variables. - * sfrsetting (keystring) 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. - status : [string] - * status (string) 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. - bedk : [string] - * bedk (string) 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. - manning : [string] - * manning (string) 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. - stage : [string] - * stage (string) 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. - inflow : [string] - * inflow (string) 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. - rainfall : [string] - * rainfall (string) 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. - evaporation : [string] - * evaporation (string) 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. - runoff : [string] - * runoff (string) 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. - diversionrecord : [idv, divflow] - * idv (integer) 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). This argument - is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and - add one when writing index variables. - * divflow (double) 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. - upstream_fraction : [double] - * upstream_fraction (double) 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. - cross_sectionrecord : [tab6_filename] - * tab6_filename (string) 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. - auxiliaryrecord : [auxname, auxval] - * auxname (string) 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. - * auxval (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the number of stream reaches. there must be nreaches + entries in the packagedata block. + packagedata : [list] + crosssections : list + connectiondata : [list] + diversions : [list] + initialstages : [list] + perioddata : list """ - auxiliary = ListTemplateGenerator(("gwf6", "sfr", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwf6", "sfr", "options", "auxiliary")) stage_filerecord = ListTemplateGenerator( ("gwf6", "sfr", "options", "stage_filerecord") ) @@ -506,7 +165,6 @@ class ModflowGwfsfr(mfpackage.MFPackage): package_abbr = "gwfsfr" _package_type = "sfr" dfn_file_name = "gwf-sfr.dfn" - dfn = [ ["header", "multi-package", "package-type advanced-stress-package"], [ @@ -740,8 +398,8 @@ class ModflowGwfsfr(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -831,8 +489,7 @@ class ModflowGwfsfr(mfpackage.MFPackage): [ "block packagedata", "name packagedata", - "type recarray ifno cellid rlen rwid rgrd rtp rbth rhk man ncon " - "ustrf ndv aux boundname", + "type recarray ifno cellid rlen rwid rgrd rtp rbth rhk man ncon ustrf ndv aux boundname", "shape (maxbound)", "reader urword", ], @@ -1155,9 +812,7 @@ class ModflowGwfsfr(mfpackage.MFPackage): [ "block period", "name sfrsetting", - "type keystring status bedk manning stage inflow rainfall " - "evaporation runoff diversionrecord upstream_fraction " - "cross_sectionrecord auxiliaryrecord", + "type keystring status bedk manning stage inflow rainfall evaporation runoff diversionrecord upstream_fraction cross_sectionrecord auxiliaryrecord", "shape", "tagged false", "in_record true", @@ -1411,9 +1066,134 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfsfr defines a SFR package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + storage : keyword + keyword that activates storage contributions to the stream-flow routing package + continuity equation. + auxiliary : [string] + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of stream + reach cells. + print_input : keyword + keyword to indicate that the list of stream reach information will be written + to the listing file immediately after it is read. + print_stage : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that stream reach flow terms will be written to the file + specified with 'budget fileout' in output control. + stage_filerecord : record + budget_filerecord : record + budgetcsv_filerecord : record + package_convergence_filerecord : record + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. + maximum_picard_iterations : integer + 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. + maximum_iterations : integer + 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. + maximum_depth_change : double precision + real value that defines the depth closure tolerance. by default, + maximum_depth_change is equal to :math:`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. + unit_conversion : double precision + real value that is used to convert user-specified manning's roughness + coefficients from seconds per meters:math:`^{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. + length_conversion : double precision + 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. + time_conversion : double precision + 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. + dev_storage_weight : double precision + real number value that defines the time weighting factor used to calculate the + change in channel storage. storage_weight must have a value between 0.5 and 1. + default storage_weight value is 1. + nreaches : integer + integer value specifying the number of stream reaches. there must be nreaches + entries in the packagedata block. + packagedata : [list] + crosssections : list + connectiondata : [list] + diversions : [list] + initialstages : [list] + perioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "sfr", filename, pname, loading_package, **kwargs) - # set up variables self.storage = self.build_mfdata("storage", storage) self.auxiliary = self.build_mfdata("auxiliary", auxiliary) self.boundnames = self.build_mfdata("boundnames", boundnames) @@ -1464,4 +1244,5 @@ def __init__( self.diversions = self.build_mfdata("diversions", diversions) self.initialstages = self.build_mfdata("initialstages", initialstages) self.perioddata = self.build_mfdata("perioddata", perioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfsto.py b/flopy/mf6/modflow/mfgwfsto.py index 4a23d4e054..3794932581 100644 --- a/flopy/mf6/modflow/mfgwfsto.py +++ b/flopy/mf6/modflow/mfgwfsto.py @@ -1,89 +1,70 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfsto(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfsto(MFPackage): """ - ModflowGwfsto defines a sto package within a gwf6 model. + ModflowGwfsto defines a STO package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - save_flows : boolean - * save_flows (boolean) keyword to indicate that cell-by-cell flow terms - will be written to the file specified with "BUDGET SAVE FILE" in - Output Control. - storagecoefficient : boolean - * storagecoefficient (boolean) keyword to indicate that the SS array is - read as storage coefficient rather than specific storage. - ss_confined_only : boolean - * ss_confined_only (boolean) 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. - perioddata : {varname:data} or tvs_perioddata data - * Contains data for the tvs package. Data can be stored in a dictionary - containing data for the tvs package with variable names as keys and - package data as values. Data just for the perioddata variable is also - acceptable. See tvs package documentation for more information. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input grid - arrays, which already support the layered keyword, should be written - to layered ascii output files. - export_array_netcdf : boolean - * export_array_netcdf (boolean) keyword that specifies input griddata - arrays should be written to the model output netcdf file. - dev_original_specific_storage : boolean - * dev_original_specific_storage (boolean) flag indicating the original - storage specific storage formulation should be used - dev_oldstorageformulation : boolean - * dev_oldstorageformulation (boolean) development option flag for old - storage formulation + save_flows : keyword + keyword to indicate that cell-by-cell flow terms will be written to the file + specified with 'budget save file' in output control. + storagecoefficient : keyword + keyword to indicate that the ss array is read as storage coefficient rather + than specific storage. + ss_confined_only : keyword + 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. + perioddata : record tvs6 filein tvs6_filename + Contains data for the tvs package. Data can be passed as a dictionary to the + tvs package with variable names as keys and package data as values. Data for + the perioddata variable is also acceptable. See tvs package documentation for + more information. + export_array_ascii : keyword + keyword that specifies input grid arrays, which already support the layered + keyword, should be written to layered ascii output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + dev_original_specific_storage : keyword + flag indicating the original storage specific storage formulation should be + used + dev_oldstorageformulation : keyword + development option flag for old storage formulation iconvert : [integer] - * iconvert (integer) 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. - ss : [double] - * ss (double) 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. - sy : [double] - * sy (double) 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). - steady_state : boolean - * steady-state (boolean) 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. - transient : boolean - * transient (boolean) keyword to indicate that stress period IPER is - transient. Transient conditions will apply until the STEADY-STATE - keyword is specified in a subsequent BEGIN PERIOD block. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + ss : [double precision] + 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. + sy : [double precision] + 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). + steady_state : keyword + 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. + transient : keyword + keyword to indicate that stress period iper is transient. transient conditions + will apply until the steady-state keyword is specified in a subsequent begin + period block. """ @@ -94,11 +75,8 @@ class ModflowGwfsto(mfpackage.MFPackage): package_abbr = "gwfsto" _package_type = "sto" dfn_file_name = "gwf-sto.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name save_flows", @@ -131,8 +109,8 @@ class ModflowGwfsto(mfpackage.MFPackage): "tagged true", "optional true", "construct_package tvs", - "construct_data tvs_perioddata", - "parameter_name perioddata", + "construct_data perioddata", + "parameter_name tvs_perioddata", ], [ "block options", @@ -207,7 +185,7 @@ class ModflowGwfsto(mfpackage.MFPackage): "layered true", "netcdf true", "optional false", - "default_value 0", + "default 0", ], [ "block griddata", @@ -219,7 +197,7 @@ class ModflowGwfsto(mfpackage.MFPackage): "layered true", "netcdf true", "optional false", - "default_value 1.e-5", + "default 1.e-5", ], [ "block griddata", @@ -231,7 +209,7 @@ class ModflowGwfsto(mfpackage.MFPackage): "layered true", "netcdf true", "optional false", - "default_value 0.15", + "default 0.15", ], [ "block period", @@ -279,7 +257,7 @@ def __init__( dev_original_specific_storage=None, dev_oldstorageformulation=None, iconvert=0, - ss=1.0e-5, + ss=1e-05, sy=0.15, steady_state=None, transient=None, @@ -287,9 +265,82 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfsto defines a STO package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + save_flows : keyword + keyword to indicate that cell-by-cell flow terms will be written to the file + specified with 'budget save file' in output control. + storagecoefficient : keyword + keyword to indicate that the ss array is read as storage coefficient rather + than specific storage. + ss_confined_only : keyword + 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. + perioddata : record tvs6 filein tvs6_filename + Contains data for the tvs package. Data can be passed as a dictionary to the + tvs package with variable names as keys and package data as values. Data for + the perioddata variable is also acceptable. See tvs package documentation for + more information. + export_array_ascii : keyword + keyword that specifies input grid arrays, which already support the layered + keyword, should be written to layered ascii output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + dev_original_specific_storage : keyword + flag indicating the original storage specific storage formulation should be + used + dev_oldstorageformulation : keyword + development option flag for old storage formulation + iconvert : [integer] + 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. + ss : [double precision] + 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. + sy : [double precision] + 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). + steady_state : keyword + 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. + transient : keyword + keyword to indicate that stress period iper is transient. transient conditions + will apply until the steady-state keyword is specified in a subsequent begin + period block. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "sto", filename, pname, loading_package, **kwargs) - # set up variables self.save_flows = self.build_mfdata("save_flows", save_flows) self.storagecoefficient = self.build_mfdata( "storagecoefficient", storagecoefficient @@ -316,4 +367,5 @@ def __init__( self.sy = self.build_mfdata("sy", sy) self.steady_state = self.build_mfdata("steady-state", steady_state) self.transient = self.build_mfdata("transient", transient) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfuzf.py b/flopy/mf6/modflow/mfgwfuzf.py index f75a05562f..b00070d714 100644 --- a/flopy/mf6/modflow/mfgwfuzf.py +++ b/flopy/mf6/modflow/mfgwfuzf.py @@ -1,275 +1,127 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfuzf(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfuzf(MFPackage): """ - ModflowGwfuzf defines a uzf package within a gwf6 model. + ModflowGwfuzf defines a UZF package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. auxiliary : [string] - * auxiliary (string) 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. + 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. auxmultname : string - * auxmultname (string) name of auxiliary variable to be used as - multiplier of GWF cell area used by UZF cell. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of UZF cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of UZF - information will be written to the listing file immediately after it - is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that UZF flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - wc_filerecord : [wcfile] - * wcfile (string) name of the binary output file to write water content - information. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - package_convergence_filerecord : [package_convergence_filename] - * package_convergence_filename (string) name of the comma spaced values - output file to write package convergence information. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - mover : boolean - * mover (boolean) 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. - simulate_et : boolean - * simulate_et (boolean) 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. - linear_gwet : boolean - * linear_gwet (boolean) keyword specifying that groundwater ET will be - simulated using the original ET formulation of MODFLOW-2005. - square_gwet : boolean - * square_gwet (boolean) 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. - simulate_gwseep : boolean - * simulate_gwseep (boolean) 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. - unsat_etwc : boolean - * unsat_etwc (boolean) 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). - unsat_etae : boolean - * unsat_etae (boolean) 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. + name of auxiliary variable to be used as multiplier of gwf cell area used by + uzf cell. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of uzf + cells. + print_input : keyword + keyword to indicate that the list of uzf information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that uzf flow terms will be written to the file specified + with 'budget fileout' in output control. + wc_filerecord : (wcfile) + * wcfile : string + name of the binary output file to write water content information. + + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + package_convergence_filerecord : (package_convergence_filename) + * package_convergence_filename : string + name of the comma spaced values output file to write package convergence + information. + + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. + simulate_et : keyword + 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. + linear_gwet : keyword + keyword specifying that groundwater et will be simulated using the original et + formulation of modflow-2005. + square_gwet : keyword + 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. + simulate_gwseep : keyword + 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. + unsat_etwc : keyword + 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). + unsat_etae : keyword + 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. nuzfcells : integer - * nuzfcells (integer) 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. + 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. ntrailwaves : integer - * ntrailwaves (integer) 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. + 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. nwavesets : integer - * nwavesets (integer) 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. - packagedata : [ifno, cellid, landflag, ivertcon, surfdep, vks, thtr, thts, - thti, eps, boundname] - * ifno (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * landflag (integer) 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. - * ivertcon (integer) 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. This argument is an index variable, which means that it - should be treated as zero-based when working with FloPy and Python. - Flopy will automatically subtract one when loading index variables - and add one when writing index variables. - * surfdep (double) is the surface depression depth of the UZF cell. - * vks (double) 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. - * thtr (double) 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. - * thts (double) 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. - * thti (double) 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. - * eps (double) 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. - * boundname (string) 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. - perioddata : [ifno, finf, pet, extdp, extwc, ha, hroot, rootact, aux] - * ifno (integer) integer value that defines the feature (UZF object) - number associated with the specified PERIOD data on the line. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * finf (string) real or character value that defines the applied - infiltration rate of the UZF cell (:math:`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. - * pet (string) 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. - * extdp (string) 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. - * extwc (string) 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. - * ha (string) 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. - * hroot (string) 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. - * rootact (string) 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 :math:`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. - * aux (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + packagedata : [list] + perioddata : list """ - auxiliary = ListTemplateGenerator(("gwf6", "uzf", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwf6", "uzf", "options", "auxiliary")) wc_filerecord = ListTemplateGenerator(("gwf6", "uzf", "options", "wc_filerecord")) budget_filerecord = ListTemplateGenerator( ("gwf6", "uzf", "options", "budget_filerecord") @@ -287,7 +139,6 @@ class ModflowGwfuzf(mfpackage.MFPackage): package_abbr = "gwfuzf" _package_type = "uzf" dfn_file_name = "gwf-uzf.dfn" - dfn = [ ["header", "multi-package", "package-type advanced-stress-package"], [ @@ -515,8 +366,8 @@ class ModflowGwfuzf(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -608,7 +459,7 @@ class ModflowGwfuzf(mfpackage.MFPackage): "type integer", "reader urword", "optional false", - "default_value 7", + "default 7", ], [ "block dimensions", @@ -616,13 +467,12 @@ class ModflowGwfuzf(mfpackage.MFPackage): "type integer", "reader urword", "optional false", - "default_value 40", + "default 40", ], [ "block packagedata", "name packagedata", - "type recarray ifno cellid landflag ivertcon surfdep vks thtr " - "thts thti eps boundname", + "type recarray ifno cellid landflag ivertcon surfdep vks thtr thts thti eps boundname", "shape (nuzfcells)", "reader urword", ], @@ -872,9 +722,120 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfuzf defines a UZF package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + auxiliary : [string] + 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. + auxmultname : string + name of auxiliary variable to be used as multiplier of gwf cell area used by + uzf cell. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of uzf + cells. + print_input : keyword + keyword to indicate that the list of uzf information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that uzf flow terms will be written to the file specified + with 'budget fileout' in output control. + wc_filerecord : record + budget_filerecord : record + budgetcsv_filerecord : record + package_convergence_filerecord : record + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. + simulate_et : keyword + 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. + linear_gwet : keyword + keyword specifying that groundwater et will be simulated using the original et + formulation of modflow-2005. + square_gwet : keyword + 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. + simulate_gwseep : keyword + 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. + unsat_etwc : keyword + 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). + unsat_etae : keyword + 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. + nuzfcells : integer + 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. + ntrailwaves : integer + 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. + nwavesets : integer + 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. + packagedata : [list] + perioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "uzf", filename, pname, loading_package, **kwargs) - # set up variables self.auxiliary = self.build_mfdata("auxiliary", auxiliary) self.auxmultname = self.build_mfdata("auxmultname", auxmultname) self.boundnames = self.build_mfdata("boundnames", boundnames) @@ -911,4 +872,5 @@ def __init__( self.nwavesets = self.build_mfdata("nwavesets", nwavesets) self.packagedata = self.build_mfdata("packagedata", packagedata) self.perioddata = self.build_mfdata("perioddata", perioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfvsc.py b/flopy/mf6/modflow/mfgwfvsc.py index e8591aee57..00f09124d6 100644 --- a/flopy/mf6/modflow/mfgwfvsc.py +++ b/flopy/mf6/modflow/mfgwfvsc.py @@ -1,112 +1,55 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfvsc(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfvsc(MFPackage): """ - ModflowGwfvsc defines a vsc package within a gwf6 model. + ModflowGwfvsc defines a VSC package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - viscref : double - * viscref (double) fluid reference viscosity used in the equation of - state. This value is set to 1.0 if not specified as an option. + viscref : double precision + fluid reference viscosity used in the equation of state. this value is set to + 1.0 if not specified as an option. temperature_species_name : string - * temperature_species_name (string) 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. + 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. thermal_formulation : string - * thermal_formulation (string) 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. - thermal_a2 : double - * thermal_a2 (double) 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). - thermal_a3 : double - * thermal_a3 (double) 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). - thermal_a4 : double - * thermal_a4 (double) 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). - viscosity_filerecord : [viscosityfile] - * viscosityfile (string) 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. + 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. + thermal_a2 : double precision + 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). + thermal_a3 : double precision + 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). + thermal_a4 : double precision + 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). + viscosity_filerecord : (viscosityfile) + * viscosityfile : string + 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. + nviscspecies : integer - * nviscspecies (integer) number of species used in the viscosity - equation of state. If either concentrations or temperature (or both) - are used to update viscosity then then nrhospecies needs to be at - least one. - packagedata : [iviscspec, dviscdc, cviscref, modelname, auxspeciesname] - * iviscspec (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - * dviscdc (double) 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. - * cviscref (double) 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. - * modelname (string) name of a GWT 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 model that - corresponds to this GWF model. - * auxspeciesname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + number of species used in the viscosity equation of state. if either + concentrations or temperature (or both) are used to update viscosity then then + nrhospecies needs to be at least one. + packagedata : [list] """ @@ -117,18 +60,15 @@ class ModflowGwfvsc(mfpackage.MFPackage): package_abbr = "gwfvsc" _package_type = "vsc" dfn_file_name = "gwf-vsc.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name viscref", "type double precision", "reader urword", "optional true", - "default_value 1.0", + "default 1.0", ], [ "block options", @@ -153,7 +93,7 @@ class ModflowGwfvsc(mfpackage.MFPackage): "type double precision", "reader urword", "optional true", - "default_value 10.", + "default 10.", ], [ "block options", @@ -161,7 +101,7 @@ class ModflowGwfvsc(mfpackage.MFPackage): "type double precision", "reader urword", "optional true", - "default_value 248.37", + "default 248.37", ], [ "block options", @@ -169,7 +109,7 @@ class ModflowGwfvsc(mfpackage.MFPackage): "type double precision", "reader urword", "optional true", - "default_value 133.15", + "default 133.15", ], [ "block options", @@ -290,9 +230,60 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfvsc defines a VSC package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + viscref : double precision + fluid reference viscosity used in the equation of state. this value is set to + 1.0 if not specified as an option. + temperature_species_name : string + 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. + thermal_formulation : string + 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. + thermal_a2 : double precision + 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). + thermal_a3 : double precision + 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). + thermal_a4 : double precision + 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). + viscosity_filerecord : record + nviscspecies : integer + number of species used in the viscosity equation of state. if either + concentrations or temperature (or both) are used to update viscosity then then + nrhospecies needs to be at least one. + packagedata : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "vsc", filename, pname, loading_package, **kwargs) - # set up variables self.viscref = self.build_mfdata("viscref", viscref) self.temperature_species_name = self.build_mfdata( "temperature_species_name", temperature_species_name @@ -308,4 +299,5 @@ def __init__( ) self.nviscspecies = self.build_mfdata("nviscspecies", nviscspecies) self.packagedata = self.build_mfdata("packagedata", packagedata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwfwel.py b/flopy/mf6/modflow/mfgwfwel.py index 08f95be2ed..014b1a45d4 100644 --- a/flopy/mf6/modflow/mfgwfwel.py +++ b/flopy/mf6/modflow/mfgwfwel.py @@ -1,133 +1,87 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwfwel(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwfwel(MFPackage): """ - ModflowGwfwel defines a wel package within a gwf6 model. + ModflowGwfwel defines a WEL package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. auxiliary : [string] - * auxiliary (string) 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. + 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. auxmultname : string - * auxmultname (string) name of auxiliary variable to be used as - multiplier of well flow rate. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of well cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of well - information will be written to the listing file immediately after it - is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that well flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - auto_flow_reduce : double - * auto_flow_reduce (double) 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). - afrcsv_filerecord : [afrcsvfile] - * afrcsvfile (string) 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. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - mover : boolean - * mover (boolean) 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. + name of auxiliary variable to be used as multiplier of well flow rate. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of well + cells. + print_input : keyword + keyword to indicate that the list of well information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that well flow terms will be written to the file specified + with 'budget fileout' in output control. + auto_flow_reduce : double precision + 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). + afrcsv_filerecord : (afrcsvfile) + * afrcsvfile : string + 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. + + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. maxbound : integer - * maxbound (integer) integer value specifying the maximum number of - wells cells that will be specified for use during any stress period. - stress_period_data : [cellid, q, aux, boundname] - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * q (double) 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. - * aux (double) 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. - * boundname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the maximum number of wells cells that will be + specified for use during any stress period. + stress_period_data : [list] """ - auxiliary = ListTemplateGenerator(("gwf6", "wel", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwf6", "wel", "options", "auxiliary")) afrcsv_filerecord = ListTemplateGenerator( ("gwf6", "wel", "options", "afrcsv_filerecord") ) @@ -139,7 +93,6 @@ class ModflowGwfwel(mfpackage.MFPackage): package_abbr = "gwfwel" _package_type = "wel" dfn_file_name = "gwf-wel.dfn" - dfn = [ ["header", "multi-package", "package-type stress-package"], [ @@ -291,8 +244,8 @@ class ModflowGwfwel(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -413,9 +366,90 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwfwel defines a WEL package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + auxiliary : [string] + 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. + auxmultname : string + name of auxiliary variable to be used as multiplier of well flow rate. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of well + cells. + print_input : keyword + keyword to indicate that the list of well information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that well flow terms will be written to the file specified + with 'budget fileout' in output control. + auto_flow_reduce : double precision + 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). + afrcsv_filerecord : record + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. + maxbound : integer + integer value specifying the maximum number of wells cells that will be + specified for use during any stress period. + stress_period_data : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "wel", filename, pname, loading_package, **kwargs) - # set up variables self.auxiliary = self.build_mfdata("auxiliary", auxiliary) self.auxmultname = self.build_mfdata("auxmultname", auxmultname) self.boundnames = self.build_mfdata("boundnames", boundnames) @@ -439,4 +473,5 @@ def __init__( self.stress_period_data = self.build_mfdata( "stress_period_data", stress_period_data ) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwt.py b/flopy/mf6/modflow/mfgwt.py index 57c2a865e1..ab3cd991ee 100644 --- a/flopy/mf6/modflow/mfgwt.py +++ b/flopy/mf6/modflow/mfgwt.py @@ -1,73 +1,43 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfmodel -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwt(mfmodel.MFModel): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfmodel import MFModel + + +class ModflowGwt(MFModel): """ - Modflowgwt defines a gwt model + ModflowGwt defines a GWT model. Parameters ---------- - modelname : string - name of the model - model_nam_file : string - relative path to the model name file from model working folder - version : string - version of modflow - exe_name : string - model executable name - model_ws : string - model working folder path - sim : MFSimulation - Simulation that this model is a part of. Model is automatically - added to simulation when it is initialized. list : string - * list (string) 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". - print_input : boolean - * print_input (boolean) keyword to indicate that the list of all model - stress package information will be written to the listing file - immediately after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that all model package flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - nc_mesh2d_filerecord : [ncmesh2dfile] - * ncmesh2dfile (string) name of the netcdf ugrid layered mesh output - file. - nc_structured_filerecord : [ncstructfile] - * ncstructfile (string) name of the netcdf structured output file. - nc_filerecord : [netcdf_filename] - * netcdf_filename (string) defines a netcdf input file. - packages : [ftype, fname, pname] - * ftype (string) 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. - * fname (string) 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. - * pname (string) 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. + 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'. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that all model package flow terms will be written to the + file specified with 'budget fileout' in output control. + nc_mesh2d_filerecord : record + netcdf layered mesh fileout record. + nc_structured_filerecord : record + netcdf structured fileout record. + nc_filerecord : record + netcdf filerecord + packages : list + Methods ------- @@ -96,6 +66,52 @@ def __init__( nc_filerecord=None, **kwargs, ): + """ + ModflowGwt defines a GWT model. + + Parameters + ---------- + modelname : string + name of the model + model_nam_file : string + relative path to the model name file from model working folder + version : string + version of modflow + exe_name : string + model executable name + model_ws : string + model working folder path + sim : MFSimulation + Simulation that this model is a part of. Model is automatically + added to simulation when it is initialized. + + list : string + 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'. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that all model package flow terms will be written to the + file specified with 'budget fileout' in output control. + nc_mesh2d_filerecord : record + netcdf layered mesh fileout record. + nc_structured_filerecord : record + netcdf structured fileout record. + nc_filerecord : record + netcdf filerecord + packages : list + + """ + super().__init__( simulation, model_type="gwt6", @@ -108,19 +124,18 @@ def __init__( ) self.name_file.list.set_data(list) - self.name_file.print_input.set_data(print_input) - self.name_file.print_flows.set_data(print_flows) - self.name_file.save_flows.set_data(save_flows) - self.name_file.nc_mesh2d_filerecord.set_data(nc_mesh2d_filerecord) - self.name_file.nc_structured_filerecord.set_data(nc_structured_filerecord) - self.name_file.nc_filerecord.set_data(nc_filerecord) - self.list = self.name_file.list + self.name_file.print_input.set_data(print_input) self.print_input = self.name_file.print_input + self.name_file.print_flows.set_data(print_flows) self.print_flows = self.name_file.print_flows + self.name_file.save_flows.set_data(save_flows) self.save_flows = self.name_file.save_flows + self.name_file.nc_mesh2d_filerecord.set_data(nc_mesh2d_filerecord) self.nc_mesh2d_filerecord = self.name_file.nc_mesh2d_filerecord + self.name_file.nc_structured_filerecord.set_data(nc_structured_filerecord) self.nc_structured_filerecord = self.name_file.nc_structured_filerecord + self.name_file.nc_filerecord.set_data(nc_filerecord) self.nc_filerecord = self.name_file.nc_filerecord @classmethod @@ -133,10 +148,10 @@ def load( version="mf6", exe_name="mf6", strict=True, - model_rel_path=".", + model_rel_path=curdir, load_only=None, ): - return mfmodel.MFModel.load_base( + return MFModel.load_base( cls, simulation, structure, diff --git a/flopy/mf6/modflow/mfgwtadv.py b/flopy/mf6/modflow/mfgwtadv.py index 13da75219c..d91a8c090a 100644 --- a/flopy/mf6/modflow/mfgwtadv.py +++ b/flopy/mf6/modflow/mfgwtadv.py @@ -1,57 +1,41 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtadv(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtadv(MFPackage): """ - ModflowGwtadv defines a adv package within a gwt6 model. + ModflowGwtadv defines a ADV package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. scheme : string - * scheme (string) scheme used to solve the advection term. Can be - upstream, central, or TVD. If not specified, upstream weighting is - the default weighting scheme. - ats_percel : double - * ats_percel (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + scheme used to solve the advection term. can be upstream, central, or tvd. if + not specified, upstream weighting is the default weighting scheme. + ats_percel : double precision + 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. """ package_abbr = "gwtadv" _package_type = "adv" dfn_file_name = "gwt-adv.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name scheme", @@ -79,9 +63,46 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtadv defines a ADV package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + scheme : string + scheme used to solve the advection term. can be upstream, central, or tvd. if + not specified, upstream weighting is the default weighting scheme. + ats_percel : double precision + 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. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "adv", filename, pname, loading_package, **kwargs) - # set up variables self.scheme = self.build_mfdata("scheme", scheme) self.ats_percel = self.build_mfdata("ats_percel", ats_percel) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtapi.py b/flopy/mf6/modflow/mfgwtapi.py index 3be267865b..1ad101a1e2 100644 --- a/flopy/mf6/modflow/mfgwtapi.py +++ b/flopy/mf6/modflow/mfgwtapi.py @@ -1,62 +1,46 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtapi(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtapi(MFPackage): """ - ModflowGwtapi defines a api package within a gwt6 model. + ModflowGwtapi defines a API package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of api boundary cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of api - boundary information will be written to the listing file immediately - after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that api boundary flow terms - will be written to the file specified with "BUDGET FILEOUT" in Output - Control. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - mover : boolean - * mover (boolean) 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of api + boundary cells. + print_input : keyword + keyword to indicate that the list of api boundary information will be written + to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that api boundary flow terms will be written to the file + specified with 'budget fileout' in output control. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. maxbound : integer - * maxbound (integer) integer value specifying the maximum number of api - boundary cells that will be specified for use during any stress - period. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the maximum number of api boundary cells that will be + specified for use during any stress period. """ @@ -64,11 +48,8 @@ class ModflowGwtapi(mfpackage.MFPackage): package_abbr = "gwtapi" _package_type = "api" dfn_file_name = "gwt-api.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name boundnames", @@ -107,8 +88,8 @@ class ModflowGwtapi(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -172,9 +153,58 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtapi defines a API package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of api + boundary cells. + print_input : keyword + keyword to indicate that the list of api boundary information will be written + to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that api boundary flow terms will be written to the file + specified with 'budget fileout' in output control. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + mover : keyword + 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. + maxbound : integer + integer value specifying the maximum number of api boundary cells that will be + specified for use during any stress period. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "api", filename, pname, loading_package, **kwargs) - # set up variables self.boundnames = self.build_mfdata("boundnames", boundnames) self.print_input = self.build_mfdata("print_input", print_input) self.print_flows = self.build_mfdata("print_flows", print_flows) @@ -185,4 +215,5 @@ def __init__( ) self.mover = self.build_mfdata("mover", mover) self.maxbound = self.build_mfdata("maxbound", maxbound) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtcnc.py b/flopy/mf6/modflow/mfgwtcnc.py index 40edd8670b..df2522ea6a 100644 --- a/flopy/mf6/modflow/mfgwtcnc.py +++ b/flopy/mf6/modflow/mfgwtcnc.py @@ -1,108 +1,64 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtcnc(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtcnc(MFPackage): """ - ModflowGwtcnc defines a cnc package within a gwt6 model. + ModflowGwtcnc defines a CNC package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. auxiliary : [string] - * auxiliary (string) 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. + 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. auxmultname : string - * auxmultname (string) name of auxiliary variable to be used as - multiplier of concentration value. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of constant concentration cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of constant - concentration information will be written to the listing file - immediately after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that constant concentration - flow terms will be written to the file specified with "BUDGET - FILEOUT" in Output Control. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. + name of auxiliary variable to be used as multiplier of concentration value. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + constant concentration cells. + print_input : keyword + keyword to indicate that the list of constant concentration information will be + written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that constant concentration flow terms will be written to + the file specified with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. maxbound : integer - * maxbound (integer) integer value specifying the maximum number of - constant concentrations cells that will be specified for use during - any stress period. - stress_period_data : [cellid, conc, aux, boundname] - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * conc (double) 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. - * aux (double) 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. - * boundname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the maximum number of constant concentrations cells + that will be specified for use during any stress period. + stress_period_data : [list] """ - auxiliary = ListTemplateGenerator(("gwt6", "cnc", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwt6", "cnc", "options", "auxiliary")) ts_filerecord = ListTemplateGenerator(("gwt6", "cnc", "options", "ts_filerecord")) obs_filerecord = ListTemplateGenerator(("gwt6", "cnc", "options", "obs_filerecord")) stress_period_data = ListTemplateGenerator( @@ -111,12 +67,8 @@ class ModflowGwtcnc(mfpackage.MFPackage): package_abbr = "gwtcnc" _package_type = "cnc" dfn_file_name = "gwt-cnc.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name auxiliary", @@ -216,8 +168,8 @@ class ModflowGwtcnc(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -328,9 +280,72 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtcnc defines a CNC package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + auxiliary : [string] + 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. + auxmultname : string + name of auxiliary variable to be used as multiplier of concentration value. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + constant concentration cells. + print_input : keyword + keyword to indicate that the list of constant concentration information will be + written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that constant concentration flow terms will be written to + the file specified with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + maxbound : integer + integer value specifying the maximum number of constant concentrations cells + that will be specified for use during any stress period. + stress_period_data : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "cnc", filename, pname, loading_package, **kwargs) - # set up variables self.auxiliary = self.build_mfdata("auxiliary", auxiliary) self.auxmultname = self.build_mfdata("auxmultname", auxmultname) self.boundnames = self.build_mfdata("boundnames", boundnames) @@ -349,4 +364,5 @@ def __init__( self.stress_period_data = self.build_mfdata( "stress_period_data", stress_period_data ) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtdis.py b/flopy/mf6/modflow/mfgwtdis.py index 564d14bbbb..e53840cd83 100644 --- a/flopy/mf6/modflow/mfgwtdis.py +++ b/flopy/mf6/modflow/mfgwtdis.py @@ -1,96 +1,84 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtdis(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtdis(MFPackage): """ - ModflowGwtdis defines a dis package within a gwt6 model. + ModflowGwtdis defines a DIS package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. length_units : string - * length_units (string) is the length units used for this model. Values - can be "FEET", "METERS", or "CENTIMETERS". If not specified, the - default is "UNKNOWN". - nogrb : boolean - * nogrb (boolean) keyword to deactivate writing of the binary grid - file. - xorigin : double - * xorigin (double) 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. - yorigin : double - * yorigin (double) 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. - angrot : double - * angrot (double) 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. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. - export_array_netcdf : boolean - * export_array_netcdf (boolean) keyword that specifies input griddata - arrays should be written to the model output netcdf file. - packagedata : {varname:data} or packagedata data - * Contains data for the ncf package. Data can be stored in a dictionary - containing data for the ncf package with variable names as keys and - package data as values. Data just for the packagedata variable is - also acceptable. See ncf package documentation for more information. + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : (grb6_filename) + * grb6_filename : string + 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'. + + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + packagedata : record ncf6 filein ncf6_filename + Contains data for the ncf package. Data can be passed as a dictionary to the + ncf package with variable names as keys and package data as values. Data for + the packagedata variable is also acceptable. See ncf package documentation for + more information. nlay : integer - * nlay (integer) is the number of layers in the model grid. + is the number of layers in the model grid. nrow : integer - * nrow (integer) is the number of rows in the model grid. + is the number of rows in the model grid. ncol : integer - * ncol (integer) is the number of columns in the model grid. - delr : [double] - * delr (double) is the column spacing in the row direction. - delc : [double] - * delc (double) is the row spacing in the column direction. - top : [double] - * top (double) is the top elevation for each cell in the top model - layer. - botm : [double] - * botm (double) is the bottom elevation for each cell. + is the number of columns in the model grid. + delr : [double precision] + is the column spacing in the row direction. + delc : [double precision] + is the row spacing in the column direction. + top : [double precision] + is the top elevation for each cell in the top model layer. + botm : [double precision] + is the bottom elevation for each cell. idomain : [integer] - * idomain (integer) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. """ + grb_filerecord = ListTemplateGenerator(("gwt6", "dis", "options", "grb_filerecord")) ncf_filerecord = ListTemplateGenerator(("gwt6", "dis", "options", "ncf_filerecord")) delr = ArrayTemplateGenerator(("gwt6", "dis", "griddata", "delr")) delc = ArrayTemplateGenerator(("gwt6", "dis", "griddata", "delc")) @@ -100,11 +88,8 @@ class ModflowGwtdis(mfpackage.MFPackage): package_abbr = "gwtdis" _package_type = "dis" dfn_file_name = "gwt-dis.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name length_units", @@ -119,6 +104,44 @@ class ModflowGwtdis(mfpackage.MFPackage): "reader urword", "optional true", ], + [ + "block options", + "name grb_filerecord", + "type record grb6 fileout grb6_filename", + "reader urword", + "tagged true", + "optional true", + ], + [ + "block options", + "name grb6", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + "extended true", + ], + [ + "block options", + "name fileout", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + ], + [ + "block options", + "name grb6_filename", + "type string", + "preserve_case true", + "in_record true", + "reader urword", + "optional false", + "tagged false", + "extended true", + ], [ "block options", "name xorigin", @@ -204,7 +227,7 @@ class ModflowGwtdis(mfpackage.MFPackage): "type integer", "reader urword", "optional false", - "default_value 1", + "default 1", ], [ "block dimensions", @@ -212,7 +235,7 @@ class ModflowGwtdis(mfpackage.MFPackage): "type integer", "reader urword", "optional false", - "default_value 2", + "default 2", ], [ "block dimensions", @@ -220,7 +243,7 @@ class ModflowGwtdis(mfpackage.MFPackage): "type integer", "reader urword", "optional false", - "default_value 2", + "default 2", ], [ "block griddata", @@ -229,7 +252,7 @@ class ModflowGwtdis(mfpackage.MFPackage): "shape (ncol)", "reader readarray", "netcdf true", - "default_value 1.0", + "default 1.0", ], [ "block griddata", @@ -238,7 +261,7 @@ class ModflowGwtdis(mfpackage.MFPackage): "shape (nrow)", "reader readarray", "netcdf true", - "default_value 1.0", + "default 1.0", ], [ "block griddata", @@ -247,7 +270,7 @@ class ModflowGwtdis(mfpackage.MFPackage): "shape (ncol, nrow)", "reader readarray", "netcdf true", - "default_value 1.0", + "default 1.0", ], [ "block griddata", @@ -257,7 +280,7 @@ class ModflowGwtdis(mfpackage.MFPackage): "reader readarray", "netcdf true", "layered true", - "default_value 0.", + "default 0.", ], [ "block griddata", @@ -277,6 +300,7 @@ def __init__( loading_package=False, length_units=None, nogrb=None, + grb_filerecord=None, xorigin=None, yorigin=None, angrot=None, @@ -295,11 +319,90 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtdis defines a DIS package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + length_units : string + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : record + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + packagedata : record ncf6 filein ncf6_filename + Contains data for the ncf package. Data can be passed as a dictionary to the + ncf package with variable names as keys and package data as values. Data for + the packagedata variable is also acceptable. See ncf package documentation for + more information. + nlay : integer + is the number of layers in the model grid. + nrow : integer + is the number of rows in the model grid. + ncol : integer + is the number of columns in the model grid. + delr : [double precision] + is the column spacing in the row direction. + delc : [double precision] + is the row spacing in the column direction. + top : [double precision] + is the top elevation for each cell in the top model layer. + botm : [double precision] + is the bottom elevation for each cell. + idomain : [integer] + 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. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "dis", filename, pname, loading_package, **kwargs) - # set up variables self.length_units = self.build_mfdata("length_units", length_units) self.nogrb = self.build_mfdata("nogrb", nogrb) + self.grb_filerecord = self.build_mfdata("grb_filerecord", grb_filerecord) self.xorigin = self.build_mfdata("xorigin", xorigin) self.yorigin = self.build_mfdata("yorigin", yorigin) self.angrot = self.build_mfdata("angrot", angrot) @@ -321,4 +424,5 @@ def __init__( self.top = self.build_mfdata("top", top) self.botm = self.build_mfdata("botm", botm) self.idomain = self.build_mfdata("idomain", idomain) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtdisu.py b/flopy/mf6/modflow/mfgwtdisu.py index 0613985e9a..0d0a765726 100644 --- a/flopy/mf6/modflow/mfgwtdisu.py +++ b/flopy/mf6/modflow/mfgwtdisu.py @@ -1,194 +1,147 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtdisu(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtdisu(MFPackage): """ - ModflowGwtdisu defines a disu package within a gwt6 model. + ModflowGwtdisu defines a DISU package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. length_units : string - * length_units (string) is the length units used for this model. Values - can be "FEET", "METERS", or "CENTIMETERS". If not specified, the - default is "UNKNOWN". - nogrb : boolean - * nogrb (boolean) keyword to deactivate writing of the binary grid - file. - xorigin : double - * xorigin (double) 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. - yorigin : double - * yorigin (double) 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. - angrot : double - * angrot (double) 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. - vertical_offset_tolerance : double - * vertical_offset_tolerance (double) 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. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : (grb6_filename) + * grb6_filename : string + 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'. + + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + vertical_offset_tolerance : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. nodes : integer - * nodes (integer) is the number of cells in the model grid. + is the number of cells in the model grid. nja : integer - * nja (integer) 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. + 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. nvert : integer - * nvert (integer) 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. - top : [double] - * top (double) is the top elevation for each cell in the model grid. - bot : [double] - * bot (double) is the bottom elevation for each cell. - area : [double] - * area (double) is the cell surface area (in plan view). + 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. + top : [double precision] + is the top elevation for each cell in the model grid. + bot : [double precision] + is the bottom elevation for each cell. + area : [double precision] + is the cell surface area (in plan view). idomain : [integer] - * idomain (integer) 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. + 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. iac : [integer] - * iac (integer) is the number of connections (plus 1) for each cell. - The sum of all the entries in IAC must be equal to NJA. + is the number of connections (plus 1) for each cell. the sum of all the + entries in iac must be equal to nja. ja : [integer] - * ja (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. + 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. ihc : [integer] - * ihc (integer) 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. - cl12 : [double] - * cl12 (double) is the array containing connection lengths between the - center of cell n and the shared face with each adjacent m cell. - hwva : [double] - * hwva (double) 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. - angldegx : [double] - * angldegx (double) 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. - vertices : [iv, xv, yv] - * iv (integer) is the vertex number. Records in the VERTICES block must - be listed in consecutive order from 1 to NVERT. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - * xv (double) is the x-coordinate for the vertex. - * yv (double) is the y-coordinate for the vertex. - cell2d : [icell2d, xc, yc, ncvert, icvert] - * icell2d (integer) is the cell2d number. Records in the CELL2D block - must be listed in consecutive order from 1 to NODES. This argument is - an index variable, which means that it should be treated as zero- - based when working with FloPy and Python. Flopy will automatically - subtract one when loading index variables and add one when writing - index variables. - * xc (double) is the x-coordinate for the cell center. - * yc (double) is the y-coordinate for the cell center. - * ncvert (integer) is the number of vertices required to define the - cell. There may be a different number of vertices for each cell. - * icvert (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + cl12 : [double precision] + is the array containing connection lengths between the center of cell n and the + shared face with each adjacent m cell. + hwva : [double precision] + 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. + angldegx : [double precision] + 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. + vertices : [list] + cell2d : [list] """ + grb_filerecord = ListTemplateGenerator( + ("gwt6", "disu", "options", "grb_filerecord") + ) top = ArrayTemplateGenerator(("gwt6", "disu", "griddata", "top")) bot = ArrayTemplateGenerator(("gwt6", "disu", "griddata", "bot")) area = ArrayTemplateGenerator(("gwt6", "disu", "griddata", "area")) @@ -204,11 +157,8 @@ class ModflowGwtdisu(mfpackage.MFPackage): package_abbr = "gwtdisu" _package_type = "disu" dfn_file_name = "gwt-disu.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name length_units", @@ -223,6 +173,44 @@ class ModflowGwtdisu(mfpackage.MFPackage): "reader urword", "optional true", ], + [ + "block options", + "name grb_filerecord", + "type record grb6 fileout grb6_filename", + "reader urword", + "tagged true", + "optional true", + ], + [ + "block options", + "name grb6", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + "extended true", + ], + [ + "block options", + "name fileout", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + ], + [ + "block options", + "name grb6_filename", + "type string", + "preserve_case true", + "in_record true", + "reader urword", + "optional false", + "tagged false", + "extended true", + ], [ "block options", "name xorigin", @@ -250,7 +238,7 @@ class ModflowGwtdisu(mfpackage.MFPackage): "type double precision", "reader urword", "optional true", - "default_value 0.0", + "default 0.0", "mf6internal voffsettol", ], [ @@ -461,6 +449,7 @@ def __init__( loading_package=False, length_units=None, nogrb=None, + grb_filerecord=None, xorigin=None, yorigin=None, angrot=None, @@ -485,11 +474,151 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtdisu defines a DISU package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + length_units : string + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : record + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + vertical_offset_tolerance : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + nodes : integer + is the number of cells in the model grid. + nja : integer + 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. + nvert : integer + 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. + top : [double precision] + is the top elevation for each cell in the model grid. + bot : [double precision] + is the bottom elevation for each cell. + area : [double precision] + is the cell surface area (in plan view). + idomain : [integer] + 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. + iac : [integer] + is the number of connections (plus 1) for each cell. the sum of all the + entries in iac must be equal to nja. + ja : [integer] + 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. + ihc : [integer] + 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. + cl12 : [double precision] + is the array containing connection lengths between the center of cell n and the + shared face with each adjacent m cell. + hwva : [double precision] + 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. + angldegx : [double precision] + 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. + vertices : [list] + cell2d : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "disu", filename, pname, loading_package, **kwargs) - # set up variables self.length_units = self.build_mfdata("length_units", length_units) self.nogrb = self.build_mfdata("nogrb", nogrb) + self.grb_filerecord = self.build_mfdata("grb_filerecord", grb_filerecord) self.xorigin = self.build_mfdata("xorigin", xorigin) self.yorigin = self.build_mfdata("yorigin", yorigin) self.angrot = self.build_mfdata("angrot", angrot) @@ -514,4 +643,5 @@ def __init__( self.angldegx = self.build_mfdata("angldegx", angldegx) self.vertices = self.build_mfdata("vertices", vertices) self.cell2d = self.build_mfdata("cell2d", cell2d) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtdisv.py b/flopy/mf6/modflow/mfgwtdisv.py index 4611ca4198..69f3ec9383 100644 --- a/flopy/mf6/modflow/mfgwtdisv.py +++ b/flopy/mf6/modflow/mfgwtdisv.py @@ -1,124 +1,89 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtdisv(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtdisv(MFPackage): """ - ModflowGwtdisv defines a disv package within a gwt6 model. + ModflowGwtdisv defines a DISV package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. length_units : string - * length_units (string) is the length units used for this model. Values - can be "FEET", "METERS", or "CENTIMETERS". If not specified, the - default is "UNKNOWN". - nogrb : boolean - * nogrb (boolean) keyword to deactivate writing of the binary grid - file. - xorigin : double - * xorigin (double) 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. - yorigin : double - * yorigin (double) 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. - angrot : double - * angrot (double) 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. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. - export_array_netcdf : boolean - * export_array_netcdf (boolean) keyword that specifies input griddata - arrays should be written to the model output netcdf file. - packagedata : {varname:data} or packagedata data - * Contains data for the ncf package. Data can be stored in a dictionary - containing data for the ncf package with variable names as keys and - package data as values. Data just for the packagedata variable is - also acceptable. See ncf package documentation for more information. + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : (grb6_filename) + * grb6_filename : string + 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'. + + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + packagedata : record ncf6 filein ncf6_filename + Contains data for the ncf package. Data can be passed as a dictionary to the + ncf package with variable names as keys and package data as values. Data for + the packagedata variable is also acceptable. See ncf package documentation for + more information. nlay : integer - * nlay (integer) is the number of layers in the model grid. + is the number of layers in the model grid. ncpl : integer - * ncpl (integer) is the number of cells per layer. This is a constant - value for the grid and it applies to all layers. + is the number of cells per layer. this is a constant value for the grid and it + applies to all layers. nvert : integer - * nvert (integer) is the total number of (x, y) vertex pairs used to - characterize the horizontal configuration of the model grid. - top : [double] - * top (double) is the top elevation for each cell in the top model - layer. - botm : [double] - * botm (double) is the bottom elevation for each cell. + is the total number of (x, y) vertex pairs used to characterize the horizontal + configuration of the model grid. + top : [double precision] + is the top elevation for each cell in the top model layer. + botm : [double precision] + is the bottom elevation for each cell. idomain : [integer] - * idomain (integer) 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. - vertices : [iv, xv, yv] - * iv (integer) is the vertex number. Records in the VERTICES block must - be listed in consecutive order from 1 to NVERT. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - * xv (double) is the x-coordinate for the vertex. - * yv (double) is the y-coordinate for the vertex. - cell2d : [icell2d, xc, yc, ncvert, icvert] - * icell2d (integer) is the CELL2D number. Records in the CELL2D block - must be listed in consecutive order from the first to the last. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * xc (double) is the x-coordinate for the cell center. - * yc (double) is the y-coordinate for the cell center. - * ncvert (integer) is the number of vertices required to define the - cell. There may be a different number of vertices for each cell. - * icvert (integer) 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. This argument is an index variable, which means that - it should be treated as zero-based when working with FloPy and - Python. Flopy will automatically subtract one when loading index - variables and add one when writing index variables. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + vertices : [list] + cell2d : [list] """ + grb_filerecord = ListTemplateGenerator( + ("gwt6", "disv", "options", "grb_filerecord") + ) ncf_filerecord = ListTemplateGenerator( ("gwt6", "disv", "options", "ncf_filerecord") ) @@ -130,11 +95,8 @@ class ModflowGwtdisv(mfpackage.MFPackage): package_abbr = "gwtdisv" _package_type = "disv" dfn_file_name = "gwt-disv.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name length_units", @@ -149,6 +111,44 @@ class ModflowGwtdisv(mfpackage.MFPackage): "reader urword", "optional true", ], + [ + "block options", + "name grb_filerecord", + "type record grb6 fileout grb6_filename", + "reader urword", + "tagged true", + "optional true", + ], + [ + "block options", + "name grb6", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + "extended true", + ], + [ + "block options", + "name fileout", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + ], + [ + "block options", + "name grb6_filename", + "type string", + "preserve_case true", + "in_record true", + "reader urword", + "optional false", + "tagged false", + "extended true", + ], [ "block options", "name xorigin", @@ -376,6 +376,7 @@ def __init__( loading_package=False, length_units=None, nogrb=None, + grb_filerecord=None, xorigin=None, yorigin=None, angrot=None, @@ -394,11 +395,93 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtdisv defines a DISV package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + length_units : string + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : record + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + packagedata : record ncf6 filein ncf6_filename + Contains data for the ncf package. Data can be passed as a dictionary to the + ncf package with variable names as keys and package data as values. Data for + the packagedata variable is also acceptable. See ncf package documentation for + more information. + nlay : integer + is the number of layers in the model grid. + ncpl : integer + is the number of cells per layer. this is a constant value for the grid and it + applies to all layers. + nvert : integer + is the total number of (x, y) vertex pairs used to characterize the horizontal + configuration of the model grid. + top : [double precision] + is the top elevation for each cell in the top model layer. + botm : [double precision] + is the bottom elevation for each cell. + idomain : [integer] + 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. + vertices : [list] + cell2d : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "disv", filename, pname, loading_package, **kwargs) - # set up variables self.length_units = self.build_mfdata("length_units", length_units) self.nogrb = self.build_mfdata("nogrb", nogrb) + self.grb_filerecord = self.build_mfdata("grb_filerecord", grb_filerecord) self.xorigin = self.build_mfdata("xorigin", xorigin) self.yorigin = self.build_mfdata("yorigin", yorigin) self.angrot = self.build_mfdata("angrot", angrot) @@ -420,4 +503,5 @@ def __init__( self.idomain = self.build_mfdata("idomain", idomain) self.vertices = self.build_mfdata("vertices", vertices) self.cell2d = self.build_mfdata("cell2d", cell2d) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtdsp.py b/flopy/mf6/modflow/mfgwtdsp.py index bbc06cdda4..c7bc6cb270 100644 --- a/flopy/mf6/modflow/mfgwtdsp.py +++ b/flopy/mf6/modflow/mfgwtdsp.py @@ -1,83 +1,68 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtdsp(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtdsp(MFPackage): """ - ModflowGwtdsp defines a dsp package within a gwt6 model. + ModflowGwtdsp defines a DSP package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - xt3d_off : boolean - * xt3d_off (boolean) 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. - xt3d_rhs : boolean - * xt3d_rhs (boolean) add xt3d terms to right-hand side, when possible. - This option uses less memory, but may require more iterations. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. - export_array_netcdf : boolean - * export_array_netcdf (boolean) keyword that specifies input griddata - arrays should be written to the model output netcdf file. - diffc : [double] - * diffc (double) effective molecular diffusion coefficient. - alh : [double] - * alh (double) 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. - alv : [double] - * alv (double) 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. - ath1 : [double] - * ath1 (double) 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. - ath2 : [double] - * ath2 (double) 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. - atv : [double] - * atv (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + xt3d_off : keyword + 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. + xt3d_rhs : keyword + add xt3d terms to right-hand side, when possible. this option uses less + memory, but may require more iterations. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + diffc : [double precision] + effective molecular diffusion coefficient. + alh : [double precision] + 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. + alv : [double precision] + 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. + ath1 : [double precision] + 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. + ath2 : [double precision] + 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. + atv : [double precision] + 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. """ @@ -90,11 +75,8 @@ class ModflowGwtdsp(mfpackage.MFPackage): package_abbr = "gwtdsp" _package_type = "dsp" dfn_file_name = "gwt-dsp.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name xt3d_off", @@ -208,9 +190,80 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtdsp defines a DSP package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + xt3d_off : keyword + 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. + xt3d_rhs : keyword + add xt3d terms to right-hand side, when possible. this option uses less + memory, but may require more iterations. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + diffc : [double precision] + effective molecular diffusion coefficient. + alh : [double precision] + 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. + alv : [double precision] + 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. + ath1 : [double precision] + 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. + ath2 : [double precision] + 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. + atv : [double precision] + 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. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "dsp", filename, pname, loading_package, **kwargs) - # set up variables self.xt3d_off = self.build_mfdata("xt3d_off", xt3d_off) self.xt3d_rhs = self.build_mfdata("xt3d_rhs", xt3d_rhs) self.export_array_ascii = self.build_mfdata( @@ -225,4 +278,5 @@ def __init__( self.ath1 = self.build_mfdata("ath1", ath1) self.ath2 = self.build_mfdata("ath2", ath2) self.atv = self.build_mfdata("atv", atv) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtfmi.py b/flopy/mf6/modflow/mfgwtfmi.py index 7903e930fe..63e6ee9105 100644 --- a/flopy/mf6/modflow/mfgwtfmi.py +++ b/flopy/mf6/modflow/mfgwtfmi.py @@ -1,55 +1,31 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtfmi(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtfmi(MFPackage): """ - ModflowGwtfmi defines a fmi package within a gwt6 model. + ModflowGwtfmi defines a FMI package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - save_flows : boolean - * save_flows (boolean) keyword to indicate that FMI flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - flow_imbalance_correction : boolean - * flow_imbalance_correction (boolean) 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. - packagedata : [flowtype, fname] - * flowtype (string) is the word GWFBUDGET, GWFHEAD, 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. - * fname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + save_flows : keyword + keyword to indicate that fmi flow terms will be written to the file specified + with 'budget fileout' in output control. + flow_imbalance_correction : keyword + 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. + packagedata : list """ @@ -57,11 +33,8 @@ class ModflowGwtfmi(mfpackage.MFPackage): package_abbr = "gwtfmi" _package_type = "fmi" dfn_file_name = "gwt-fmi.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name save_flows", @@ -123,12 +96,47 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtfmi defines a FMI package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + save_flows : keyword + keyword to indicate that fmi flow terms will be written to the file specified + with 'budget fileout' in output control. + flow_imbalance_correction : keyword + 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. + packagedata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "fmi", filename, pname, loading_package, **kwargs) - # set up variables self.save_flows = self.build_mfdata("save_flows", save_flows) self.flow_imbalance_correction = self.build_mfdata( "flow_imbalance_correction", flow_imbalance_correction ) self.packagedata = self.build_mfdata("packagedata", packagedata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtgwt.py b/flopy/mf6/modflow/mfgwtgwt.py index c471b5a414..68da8fe1c5 100644 --- a/flopy/mf6/modflow/mfgwtgwt.py +++ b/flopy/mf6/modflow/mfgwtgwt.py @@ -1,167 +1,93 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify -class ModflowGwtgwt(mfpackage.MFPackage): +from os import PathLike, curdir +from typing import Union + +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFPackage + + +class ModflowGwtgwt(MFPackage): """ - ModflowGwtgwt defines a gwtgwt package. + ModflowGwtgwt defines a GWTGWT package. Parameters ---------- - simulation : MFSimulation - Simulation that this package is a part of. Package is automatically - added to simulation when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - exgtype : - * is the exchange type (GWF-GWF or GWF-GWT). - exgmnamea : - * is the name of the first model that is part of this exchange. - exgmnameb : - * is the name of the second model that is part of this exchange. gwfmodelname1 : string - * gwfmodelname1 (string) 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. + 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. gwfmodelname2 : string - * gwfmodelname2 (string) 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. + 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. auxiliary : [string] - * auxiliary (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of GWT Exchange cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of exchange - entries will be echoed to the listing file immediately after it is - read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) 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. + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of gwt + exchange cells. + print_input : keyword + keyword to indicate that the list of exchange entries will be echoed to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + 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. adv_scheme : string - * adv_scheme (string) scheme used to solve the advection term. Can be - upstream, central, or TVD. If not specified, upstream weighting is - the default weighting scheme. - dsp_xt3d_off : boolean - * dsp_xt3d_off (boolean) deactivate the xt3d method for the dispersive - flux and use the faster and less accurate approximation for this - exchange. - dsp_xt3d_rhs : boolean - * dsp_xt3d_rhs (boolean) add xt3d dispersion terms to right-hand side, - when possible, for this exchange. - filein : boolean - * filein (boolean) keyword to specify that an input filename is - expected next. - perioddata : {varname:data} or perioddata data - * Contains data for the mvt package. Data can be stored in a dictionary - containing data for the mvt package with variable names as keys and - package data as values. Data just for the perioddata variable is also - acceptable. See mvt package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - dev_interfacemodel_on : boolean - * dev_interfacemodel_on (boolean) activates the interface model - mechanism for calculating the coefficients at (and possibly near) the - exchange. This keyword should only be used for development purposes. + scheme used to solve the advection term. can be upstream, central, or tvd. if + not specified, upstream weighting is the default weighting scheme. + dsp_xt3d_off : keyword + deactivate the xt3d method for the dispersive flux and use the faster and less + accurate approximation for this exchange. + dsp_xt3d_rhs : keyword + add xt3d dispersion terms to right-hand side, when possible, for this exchange. + perioddata : record mvt6 filein mvt6_filename + Contains data for the mvt package. Data can be passed as a dictionary to the + mvt package with variable names as keys and package data as values. Data for + the perioddata variable is also acceptable. See mvt package documentation for + more information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + dev_interfacemodel_on : keyword + activates the interface model mechanism for calculating the coefficients at + (and possibly near) the exchange. this keyword should only be used for + development purposes. nexg : integer - * nexg (integer) keyword and integer value specifying the number of - GWT-GWT exchanges. - exchangedata : [cellidm1, cellidm2, ihc, cl1, cl2, hwva, aux, boundname] - * cellidm1 ((integer, ...)) 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. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - * cellidm2 ((integer, ...)) 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. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - * ihc (integer) 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. - * cl1 (double) is the distance between the center of cell 1 and the its - shared face with cell 2. - * cl2 (double) is the distance between the center of cell 2 and the its - shared face with cell 1. - * hwva (double) 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. - * aux (double) 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. - * boundname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + keyword and integer value specifying the number of gwt-gwt exchanges. + exchangedata : [list] """ - auxiliary = ListTemplateGenerator(("gwtgwt", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwtgwt", "options", "auxiliary")) mvt_filerecord = ListTemplateGenerator(("gwtgwt", "options", "mvt_filerecord")) obs_filerecord = ListTemplateGenerator(("gwtgwt", "options", "obs_filerecord")) exchangedata = ListTemplateGenerator(("gwtgwt", "exchangedata", "exchangedata")) package_abbr = "gwtgwt" _package_type = "gwtgwt" dfn_file_name = "exg-gwtgwt.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name gwfmodelname1", @@ -291,8 +217,8 @@ class ModflowGwtgwt(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -433,7 +359,6 @@ def __init__( adv_scheme=None, dsp_xt3d_off=None, dsp_xt3d_rhs=None, - filein=None, perioddata=None, observations=None, dev_interfacemodel_on=None, @@ -443,17 +368,103 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtgwt defines a GWTGWT package. + + simulation : MFSimulation + Simulation that this package is a part of. Package is automatically + added to simulation when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + exgtype : str + The exchange type (GWF-GWF or GWF-GWT). + exgmnamea : str + The name of the first model that is part of this exchange. + exgmnameb : str + The name of the second model that is part of this exchange. + gwfmodelname1 : str + Name of first 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. + gwfmodelname2 : str + Name of second 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. + gwfmodelname1 : string + 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. + gwfmodelname2 : string + 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. + auxiliary : [string] + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of gwt + exchange cells. + print_input : keyword + keyword to indicate that the list of exchange entries will be echoed to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + 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. + adv_scheme : string + scheme used to solve the advection term. can be upstream, central, or tvd. if + not specified, upstream weighting is the default weighting scheme. + dsp_xt3d_off : keyword + deactivate the xt3d method for the dispersive flux and use the faster and less + accurate approximation for this exchange. + dsp_xt3d_rhs : keyword + add xt3d dispersion terms to right-hand side, when possible, for this exchange. + perioddata : record mvt6 filein mvt6_filename + Contains data for the mvt package. Data can be passed as a dictionary to the + mvt package with variable names as keys and package data as values. Data for + the perioddata variable is also acceptable. See mvt package documentation for + more information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + dev_interfacemodel_on : keyword + activates the interface model mechanism for calculating the coefficients at + (and possibly near) the exchange. this keyword should only be used for + development purposes. + nexg : integer + keyword and integer value specifying the number of gwt-gwt exchanges. + exchangedata : [list] + + """ + super().__init__( simulation, "gwtgwt", filename, pname, loading_package, **kwargs ) - # set up variables self.exgtype = exgtype - self.exgmnamea = exgmnamea - self.exgmnameb = exgmnameb - simulation.register_exchange_file(self) self.gwfmodelname1 = self.build_mfdata("gwfmodelname1", gwfmodelname1) @@ -466,7 +477,6 @@ def __init__( self.adv_scheme = self.build_mfdata("adv_scheme", adv_scheme) self.dsp_xt3d_off = self.build_mfdata("dsp_xt3d_off", dsp_xt3d_off) self.dsp_xt3d_rhs = self.build_mfdata("dsp_xt3d_rhs", dsp_xt3d_rhs) - self.filein = self.build_mfdata("filein", filein) self._mvt_filerecord = self.build_mfdata("mvt_filerecord", None) self._mvt_package = self.build_child_package( "mvt", perioddata, "perioddata", self._mvt_filerecord @@ -480,4 +490,5 @@ def __init__( ) self.nexg = self.build_mfdata("nexg", nexg) self.exchangedata = self.build_mfdata("exchangedata", exchangedata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtic.py b/flopy/mf6/modflow/mfgwtic.py index 1a4a67444f..3d9cb93c3b 100644 --- a/flopy/mf6/modflow/mfgwtic.py +++ b/flopy/mf6/modflow/mfgwtic.py @@ -1,41 +1,28 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtic(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtic(MFPackage): """ - ModflowGwtic defines a ic package within a gwt6 model. + ModflowGwtic defines a IC package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. - export_array_netcdf : boolean - * export_array_netcdf (boolean) keyword that specifies input griddata - arrays should be written to the model output netcdf file. - strt : [double] - * strt (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + strt : [double precision] + 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. """ @@ -43,11 +30,8 @@ class ModflowGwtic(mfpackage.MFPackage): package_abbr = "gwtic" _package_type = "ic" dfn_file_name = "gwt-ic.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name export_array_ascii", @@ -73,7 +57,7 @@ class ModflowGwtic(mfpackage.MFPackage): "reader readarray", "layered true", "netcdf true", - "default_value 0.0", + "default 0.0", ], ] @@ -88,9 +72,40 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtic defines a IC package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + strt : [double precision] + 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. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "ic", filename, pname, loading_package, **kwargs) - # set up variables self.export_array_ascii = self.build_mfdata( "export_array_ascii", export_array_ascii ) @@ -98,4 +113,5 @@ def __init__( "export_array_netcdf", export_array_netcdf ) self.strt = self.build_mfdata("strt", strt) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtist.py b/flopy/mf6/modflow/mfgwtist.py index 2b2e4da8ba..a117c84a4f 100644 --- a/flopy/mf6/modflow/mfgwtist.py +++ b/flopy/mf6/modflow/mfgwtist.py @@ -1,132 +1,105 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtist(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtist(MFPackage): """ - ModflowGwtist defines a ist package within a gwt6 model. + ModflowGwtist defines a IST package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - save_flows : boolean - * save_flows (boolean) keyword to indicate that IST flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. + save_flows : keyword + keyword to indicate that ist flow terms will be written to the file specified + with 'budget fileout' in output control. + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + sorption : string - * sorption (string) 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. - first_order_decay : boolean - * first_order_decay (boolean) 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. - zero_order_decay : boolean - * zero_order_decay (boolean) 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. - cim_filerecord : [cimfile] - * cimfile (string) 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. - cimprintrecord : [columns, width, digits, format] - * columns (integer) number of columns for writing data. - * width (integer) width for writing each number. - * digits (integer) number of digits to use for writing a number. - * format (string) write format can be EXPONENTIAL, FIXED, GENERAL, or - SCIENTIFIC. - sorbate_filerecord : [sorbatefile] - * sorbatefile (string) 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. - porosity : [double] - * porosity (double) porosity of the immobile domain specified as the - immobile domain pore volume per immobile domain volume. - volfrac : [double] - * volfrac (double) fraction of the cell volume that consists of this - immobile domain. The sum of all immobile domain volume fractions must - be less than one. - zetaim : [double] - * zetaim (double) mass transfer rate coefficient between the mobile and - immobile domains, in dimensions of per time. - cim : [double] - * cim (double) initial concentration of the immobile domain in mass per - length cubed. If CIM is not specified, then it is assumed to be zero. - decay : [double] - * decay (double) 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. - decay_sorbed : [double] - * decay_sorbed (double) 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. - bulk_density : [double] - * bulk_density (double) 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. - distcoef : [double] - * distcoef (double) 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. - sp2 : [double] - * sp2 (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + first_order_decay : keyword + 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. + zero_order_decay : keyword + 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. + cim_filerecord : record + cimprintrecord : (print_format) + * print_format : keyword + keyword to specify format for printing to the listing file. + + sorbate_filerecord : (sorbatefile) + * sorbatefile : string + 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. + + porosity : [double precision] + porosity of the immobile domain specified as the immobile domain pore volume + per immobile domain volume. + volfrac : [double precision] + fraction of the cell volume that consists of this immobile domain. the sum of + all immobile domain volume fractions must be less than one. + zetaim : [double precision] + mass transfer rate coefficient between the mobile and immobile domains, in + dimensions of per time. + cim : [double precision] + initial concentration of the immobile domain in mass per length cubed. if cim + is not specified, then it is assumed to be zero. + decay : [double precision] + 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. + decay_sorbed : [double precision] + 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. + bulk_density : [double precision] + 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. + distcoef : [double precision] + 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. + sp2 : [double precision] + 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. """ @@ -153,11 +126,8 @@ class ModflowGwtist(mfpackage.MFPackage): package_abbr = "gwtist" _package_type = "ist" dfn_file_name = "gwt-ist.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name save_flows", @@ -491,9 +461,103 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtist defines a IST package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + save_flows : keyword + keyword to indicate that ist flow terms will be written to the file specified + with 'budget fileout' in output control. + budget_filerecord : record + budgetcsv_filerecord : record + sorption : string + 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. + first_order_decay : keyword + 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. + zero_order_decay : keyword + 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. + cim_filerecord : record + cimprintrecord : (print_format) + * print_format : keyword + keyword to specify format for printing to the listing file. + + sorbate_filerecord : record + porosity : [double precision] + porosity of the immobile domain specified as the immobile domain pore volume + per immobile domain volume. + volfrac : [double precision] + fraction of the cell volume that consists of this immobile domain. the sum of + all immobile domain volume fractions must be less than one. + zetaim : [double precision] + mass transfer rate coefficient between the mobile and immobile domains, in + dimensions of per time. + cim : [double precision] + initial concentration of the immobile domain in mass per length cubed. if cim + is not specified, then it is assumed to be zero. + decay : [double precision] + 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. + decay_sorbed : [double precision] + 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. + bulk_density : [double precision] + 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. + distcoef : [double precision] + 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. + sp2 : [double precision] + 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. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "ist", filename, pname, loading_package, **kwargs) - # set up variables self.save_flows = self.build_mfdata("save_flows", save_flows) self.budget_filerecord = self.build_mfdata( "budget_filerecord", budget_filerecord @@ -520,4 +584,5 @@ def __init__( self.bulk_density = self.build_mfdata("bulk_density", bulk_density) self.distcoef = self.build_mfdata("distcoef", distcoef) self.sp2 = self.build_mfdata("sp2", sp2) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtlkt.py b/flopy/mf6/modflow/mfgwtlkt.py index e7231a9bb3..f2d4542d5d 100644 --- a/flopy/mf6/modflow/mfgwtlkt.py +++ b/flopy/mf6/modflow/mfgwtlkt.py @@ -1,207 +1,92 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtlkt(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtlkt(MFPackage): """ - ModflowGwtlkt defines a lkt package within a gwt6 model. + ModflowGwtlkt defines a LKT package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. flow_package_name : string - * flow_package_name (string) 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). + 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). auxiliary : [string] - * auxiliary (string) 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. + 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. flow_package_auxiliary_name : string - * flow_package_auxiliary_name (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of lake cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of lake - information will be written to the listing file immediately after it - is read. - print_concentration : boolean - * print_concentration (boolean) keyword to indicate that the list of - lake concentration 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_CONCENTRATION - is specified, then concentration are printed for the last time step - of each stress period. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that lake flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - concentration_filerecord : [concfile] - * concfile (string) name of the binary output file to write - concentration information. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - packagedata : [ifno, strt, aux, boundname] - * ifno (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * strt (double) real value that defines the starting concentration for - the lake. - * aux (double) 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. - * boundname (string) 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. - lakeperioddata : [ifno, laksetting] - * ifno (integer) 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. This argument is - an index variable, which means that it should be treated as zero- - based when working with FloPy and Python. Flopy will automatically - subtract one when loading index variables and add one when writing - index variables. - * laksetting (keystring) 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. - status : [string] - * status (string) 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. - concentration : [string] - * concentration (string) 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. - rainfall : [string] - * rainfall (string) real or character value that defines the - rainfall solute concentration :math:`(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. - evaporation : [string] - * evaporation (string) real or character value that defines the - concentration of evaporated water :math:`(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. - runoff : [string] - * runoff (string) real or character value that defines the - concentration of runoff :math:`(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. - ext_inflow : [string] - * ext-inflow (string) real or character value that defines the - concentration of external inflow :math:`(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. - auxiliaryrecord : [auxname, auxval] - * auxname (string) 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. - * auxval (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of lake + cells. + print_input : keyword + keyword to indicate that the list of lake information will be written to the + listing file immediately after it is read. + print_concentration : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that lake flow terms will be written to the file specified + with 'budget fileout' in output control. + concentration_filerecord : (concfile) + * concfile : string + name of the binary output file to write concentration information. + + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + lakeperioddata : list """ - auxiliary = ListTemplateGenerator(("gwt6", "lkt", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwt6", "lkt", "options", "auxiliary")) concentration_filerecord = ListTemplateGenerator( ("gwt6", "lkt", "options", "concentration_filerecord") ) @@ -218,12 +103,8 @@ class ModflowGwtlkt(mfpackage.MFPackage): package_abbr = "gwtlkt" _package_type = "lkt" dfn_file_name = "gwt-lkt.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name flow_package_name", @@ -435,8 +316,8 @@ class ModflowGwtlkt(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -537,8 +418,7 @@ class ModflowGwtlkt(mfpackage.MFPackage): [ "block period", "name laksetting", - "type keystring status concentration rainfall evaporation runoff " - "ext-inflow auxiliaryrecord", + "type keystring status concentration rainfall evaporation runoff ext-inflow auxiliaryrecord", "shape", "tagged false", "in_record true", @@ -664,9 +544,89 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtlkt defines a LKT package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + flow_package_name : string + 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). + auxiliary : [string] + 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. + flow_package_auxiliary_name : string + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of lake + cells. + print_input : keyword + keyword to indicate that the list of lake information will be written to the + listing file immediately after it is read. + print_concentration : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that lake flow terms will be written to the file specified + with 'budget fileout' in output control. + concentration_filerecord : record + budget_filerecord : record + budgetcsv_filerecord : record + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + lakeperioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "lkt", filename, pname, loading_package, **kwargs) - # set up variables self.flow_package_name = self.build_mfdata( "flow_package_name", flow_package_name ) @@ -700,4 +660,5 @@ def __init__( ) self.packagedata = self.build_mfdata("packagedata", packagedata) self.lakeperioddata = self.build_mfdata("lakeperioddata", lakeperioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtmst.py b/flopy/mf6/modflow/mfgwtmst.py index 463714cc9b..cfc18c7c6c 100644 --- a/flopy/mf6/modflow/mfgwtmst.py +++ b/flopy/mf6/modflow/mfgwtmst.py @@ -1,101 +1,79 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtmst(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtmst(MFPackage): """ - ModflowGwtmst defines a mst package within a gwt6 model. + ModflowGwtmst defines a MST package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - save_flows : boolean - * save_flows (boolean) keyword to indicate that MST flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - first_order_decay : boolean - * first_order_decay (boolean) 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. - zero_order_decay : boolean - * zero_order_decay (boolean) 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. + save_flows : keyword + keyword to indicate that mst flow terms will be written to the file specified + with 'budget fileout' in output control. + first_order_decay : keyword + 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. + zero_order_decay : keyword + 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. sorption : string - * sorption (string) 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. - sorbate_filerecord : [sorbatefile] - * sorbatefile (string) 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. - porosity : [double] - * porosity (double) 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. - decay : [double] - * decay (double) 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. - decay_sorbed : [double] - * decay_sorbed (double) 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. - bulk_density : [double] - * bulk_density (double) 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. - distcoef : [double] - * distcoef (double) 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. - sp2 : [double] - * sp2 (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + sorbate_filerecord : (sorbatefile) + * sorbatefile : string + 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. + + porosity : [double precision] + 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. + decay : [double precision] + 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. + decay_sorbed : [double precision] + 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. + bulk_density : [double precision] + 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. + distcoef : [double precision] + 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. + sp2 : [double precision] + 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. """ @@ -111,11 +89,8 @@ class ModflowGwtmst(mfpackage.MFPackage): package_abbr = "gwtmst" _package_type = "mst" dfn_file_name = "gwt-mst.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name save_flows", @@ -259,9 +234,86 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtmst defines a MST package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + save_flows : keyword + keyword to indicate that mst flow terms will be written to the file specified + with 'budget fileout' in output control. + first_order_decay : keyword + 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. + zero_order_decay : keyword + 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. + sorption : string + 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. + sorbate_filerecord : record + porosity : [double precision] + 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. + decay : [double precision] + 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. + decay_sorbed : [double precision] + 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. + bulk_density : [double precision] + 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. + distcoef : [double precision] + 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. + sp2 : [double precision] + 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. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "mst", filename, pname, loading_package, **kwargs) - # set up variables self.save_flows = self.build_mfdata("save_flows", save_flows) self.first_order_decay = self.build_mfdata( "first_order_decay", first_order_decay @@ -277,4 +329,5 @@ def __init__( self.bulk_density = self.build_mfdata("bulk_density", bulk_density) self.distcoef = self.build_mfdata("distcoef", distcoef) self.sp2 = self.build_mfdata("sp2", sp2) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtmvt.py b/flopy/mf6/modflow/mfgwtmvt.py index 265d8a126c..f03a5e229a 100644 --- a/flopy/mf6/modflow/mfgwtmvt.py +++ b/flopy/mf6/modflow/mfgwtmvt.py @@ -1,52 +1,40 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtmvt(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtmvt(MFPackage): """ - ModflowGwtmvt defines a mvt package within a gwt6 model. + ModflowGwtmvt defines a MVT package. Parameters ---------- - parent_model_or_package : MFModel/MFPackage - Parent_model_or_package that this package is a part of. Package is automatically - added to parent_model_or_package when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of mover - information will be written to the listing file immediately after it - is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that lake flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + print_input : keyword + keyword to indicate that the list of mover information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that lake flow terms will be written to the file specified + with 'budget fileout' in output control. + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + """ @@ -59,11 +47,8 @@ class ModflowGwtmvt(mfpackage.MFPackage): package_abbr = "gwtmvt" _package_type = "mvt" dfn_file_name = "gwt-mvt.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name print_input", @@ -170,11 +155,46 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtmvt defines a MVT package. + + Parameters + ---------- + parent_model_or_package + Parent_model_or_package that this package is a part of. Package is automatically + added to parent_model_or_package when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + print_input : keyword + keyword to indicate that the list of mover information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that lake flow terms will be written to the file specified + with 'budget fileout' in output control. + budget_filerecord : record + budgetcsv_filerecord : record + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__( parent_model_or_package, "mvt", filename, pname, loading_package, **kwargs ) - # set up variables self.print_input = self.build_mfdata("print_input", print_input) self.print_flows = self.build_mfdata("print_flows", print_flows) self.save_flows = self.build_mfdata("save_flows", save_flows) @@ -184,10 +204,11 @@ def __init__( self.budgetcsv_filerecord = self.build_mfdata( "budgetcsv_filerecord", budgetcsv_filerecord ) + self._init_complete = True -class GwtmvtPackages(mfpackage.MFChildPackages): +class GwtmvtPackages(MFChildPackages): """ GwtmvtPackages is a container class for the ModflowGwtmvt class. @@ -200,6 +221,7 @@ class GwtmvtPackages(mfpackage.MFChildPackages): append_package Adds a new ModflowGwtmvt package to the container. See ModflowGwtmvt init documentation for definition of parameters. + """ package_abbr = "gwtmvtpackages" diff --git a/flopy/mf6/modflow/mfgwtmwt.py b/flopy/mf6/modflow/mfgwtmwt.py index 771926fcc3..26f819d9c7 100644 --- a/flopy/mf6/modflow/mfgwtmwt.py +++ b/flopy/mf6/modflow/mfgwtmwt.py @@ -1,182 +1,92 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtmwt(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtmwt(MFPackage): """ - ModflowGwtmwt defines a mwt package within a gwt6 model. + ModflowGwtmwt defines a MWT package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. flow_package_name : string - * flow_package_name (string) 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). + 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). auxiliary : [string] - * auxiliary (string) 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. + 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. flow_package_auxiliary_name : string - * flow_package_auxiliary_name (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of well cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of well - information will be written to the listing file immediately after it - is read. - print_concentration : boolean - * print_concentration (boolean) keyword to indicate that the list of - well concentration 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_CONCENTRATION - is specified, then concentration are printed for the last time step - of each stress period. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that well flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - concentration_filerecord : [concfile] - * concfile (string) name of the binary output file to write - concentration information. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - packagedata : [ifno, strt, aux, boundname] - * ifno (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * strt (double) real value that defines the starting concentration for - the well. - * aux (double) 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. - * boundname (string) 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. - mwtperioddata : [ifno, mwtsetting] - * ifno (integer) 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. This argument - is an index variable, which means that it should be treated as zero- - based when working with FloPy and Python. Flopy will automatically - subtract one when loading index variables and add one when writing - index variables. - * mwtsetting (keystring) 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. - status : [string] - * status (string) 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. - concentration : [string] - * concentration (string) 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. - rate : [string] - * rate (string) real or character value that defines the - injection solute concentration :math:`(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. - auxiliaryrecord : [auxname, auxval] - * auxname (string) 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. - * auxval (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of well + cells. + print_input : keyword + keyword to indicate that the list of well information will be written to the + listing file immediately after it is read. + print_concentration : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that well flow terms will be written to the file specified + with 'budget fileout' in output control. + concentration_filerecord : (concfile) + * concfile : string + name of the binary output file to write concentration information. + + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + mwtperioddata : list """ - auxiliary = ListTemplateGenerator(("gwt6", "mwt", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwt6", "mwt", "options", "auxiliary")) concentration_filerecord = ListTemplateGenerator( ("gwt6", "mwt", "options", "concentration_filerecord") ) @@ -193,12 +103,8 @@ class ModflowGwtmwt(mfpackage.MFPackage): package_abbr = "gwtmwt" _package_type = "mwt" dfn_file_name = "gwt-mwt.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name flow_package_name", @@ -410,8 +316,8 @@ class ModflowGwtmwt(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -608,9 +514,89 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtmwt defines a MWT package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + flow_package_name : string + 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). + auxiliary : [string] + 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. + flow_package_auxiliary_name : string + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of well + cells. + print_input : keyword + keyword to indicate that the list of well information will be written to the + listing file immediately after it is read. + print_concentration : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that well flow terms will be written to the file specified + with 'budget fileout' in output control. + concentration_filerecord : record + budget_filerecord : record + budgetcsv_filerecord : record + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + mwtperioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "mwt", filename, pname, loading_package, **kwargs) - # set up variables self.flow_package_name = self.build_mfdata( "flow_package_name", flow_package_name ) @@ -644,4 +630,5 @@ def __init__( ) self.packagedata = self.build_mfdata("packagedata", packagedata) self.mwtperioddata = self.build_mfdata("mwtperioddata", mwtperioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtnam.py b/flopy/mf6/modflow/mfgwtnam.py index 0324365307..7e2deca1f1 100644 --- a/flopy/mf6/modflow/mfgwtnam.py +++ b/flopy/mf6/modflow/mfgwtnam.py @@ -1,74 +1,51 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtnam(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtnam(MFPackage): """ - ModflowGwtnam defines a nam package within a gwt6 model. + ModflowGwtnam defines a NAM package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. list : string - * list (string) 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". - print_input : boolean - * print_input (boolean) keyword to indicate that the list of all model - stress package information will be written to the listing file - immediately after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that all model package flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - nc_mesh2d_filerecord : [ncmesh2dfile] - * ncmesh2dfile (string) name of the netcdf ugrid layered mesh output - file. - nc_structured_filerecord : [ncstructfile] - * ncstructfile (string) name of the netcdf structured output file. - nc_filerecord : [netcdf_filename] - * netcdf_filename (string) defines a netcdf input file. - packages : [ftype, fname, pname] - * ftype (string) 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. - * fname (string) 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. - * pname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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'. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that all model package flow terms will be written to the + file specified with 'budget fileout' in output control. + nc_mesh2d_filerecord : (ncmesh2dfile) + netcdf layered mesh fileout record. + * ncmesh2dfile : string + name of the netcdf ugrid layered mesh output file. + + nc_structured_filerecord : (ncstructfile) + netcdf structured fileout record. + * ncstructfile : string + name of the netcdf structured output file. + + nc_filerecord : (netcdf_filename) + netcdf filerecord + * netcdf_filename : string + defines a netcdf input file. + + packages : list """ @@ -83,11 +60,8 @@ class ModflowGwtnam(mfpackage.MFPackage): package_abbr = "gwtnam" _package_type = "nam" dfn_file_name = "gwt-nam.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name list", @@ -284,9 +258,54 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtnam defines a NAM package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + list : string + 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'. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that all model package flow terms will be written to the + file specified with 'budget fileout' in output control. + nc_mesh2d_filerecord : record + netcdf layered mesh fileout record. + nc_structured_filerecord : record + netcdf structured fileout record. + nc_filerecord : record + netcdf filerecord + packages : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "nam", filename, pname, loading_package, **kwargs) - # set up variables self.list = self.build_mfdata("list", list) self.print_input = self.build_mfdata("print_input", print_input) self.print_flows = self.build_mfdata("print_flows", print_flows) @@ -299,4 +318,5 @@ def __init__( ) self.nc_filerecord = self.build_mfdata("nc_filerecord", nc_filerecord) self.packages = self.build_mfdata("packages", packages) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtoc.py b/flopy/mf6/modflow/mfgwtoc.py index 4eda4cfdeb..a03a7fb734 100644 --- a/flopy/mf6/modflow/mfgwtoc.py +++ b/flopy/mf6/modflow/mfgwtoc.py @@ -1,94 +1,54 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtoc(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtoc(MFPackage): """ - ModflowGwtoc defines a oc package within a gwt6 model. + ModflowGwtoc defines a OC package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - concentration_filerecord : [concentrationfile] - * concentrationfile (string) name of the output file to write conc - information. - concentrationprintrecord : [columns, width, digits, format] - * columns (integer) number of columns for writing data. - * width (integer) width for writing each number. - * digits (integer) number of digits to use for writing a number. - * format (string) write format can be EXPONENTIAL, FIXED, GENERAL, or - SCIENTIFIC. - saverecord : [rtype, ocsetting] - * rtype (string) type of information to save or print. Can be BUDGET or - CONCENTRATION. - * ocsetting (keystring) specifies the steps for which the data will be - saved. - all : [keyword] - * all (keyword) keyword to indicate save for all time steps in - period. - first : [keyword] - * first (keyword) 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. - last : [keyword] - * last (keyword) 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. - frequency : [integer] - * frequency (integer) 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. - steps : [integer] - * steps (integer) 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. - printrecord : [rtype, ocsetting] - * rtype (string) type of information to save or print. Can be BUDGET or - CONCENTRATION. - * ocsetting (keystring) specifies the steps for which the data will be - saved. - all : [keyword] - * all (keyword) keyword to indicate save for all time steps in - period. - first : [keyword] - * first (keyword) 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. - last : [keyword] - * last (keyword) 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. - frequency : [integer] - * frequency (integer) 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. - steps : [integer] - * steps (integer) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + budget_filerecord : (budgetfile) + * budgetfile : string + name of the output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + concentration_filerecord : (concentrationfile) + * concentrationfile : string + name of the output file to write conc information. + + concentrationprintrecord : (concentration, print_format) + * concentration : keyword + keyword to specify that record corresponds to concentration. + * print_format : keyword + keyword to specify format for printing to the listing file. + + saverecord : (save, rtype, ocsetting) + * save : keyword + keyword to indicate that information will be saved this stress period. + * rtype : string + type of information to save or print. Can be BUDGET or CONCENTRATION. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + + printrecord : (print, rtype, ocsetting) + * print : keyword + keyword to indicate that information will be printed this stress period. + * rtype : string + type of information to save or print. Can be BUDGET or CONCENTRATION. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + """ @@ -109,11 +69,8 @@ class ModflowGwtoc(mfpackage.MFPackage): package_abbr = "gwtoc" _package_type = "oc" dfn_file_name = "gwt-oc.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name budget_filerecord", @@ -409,9 +366,55 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtoc defines a OC package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + budget_filerecord : record + budgetcsv_filerecord : record + concentration_filerecord : record + concentrationprintrecord : (concentration, print_format) + * concentration : keyword + keyword to specify that record corresponds to concentration. + * print_format : keyword + keyword to specify format for printing to the listing file. + + saverecord : (save, rtype, ocsetting) + * save : keyword + keyword to indicate that information will be saved this stress period. + * rtype : string + type of information to save or print. Can be BUDGET or CONCENTRATION. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + + printrecord : (print, rtype, ocsetting) + * print : keyword + keyword to indicate that information will be printed this stress period. + * rtype : string + type of information to save or print. Can be BUDGET or CONCENTRATION. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "oc", filename, pname, loading_package, **kwargs) - # set up variables self.budget_filerecord = self.build_mfdata( "budget_filerecord", budget_filerecord ) @@ -426,4 +429,5 @@ def __init__( ) self.saverecord = self.build_mfdata("saverecord", saverecord) self.printrecord = self.build_mfdata("printrecord", printrecord) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtsft.py b/flopy/mf6/modflow/mfgwtsft.py index b8013621f9..378615ccf0 100644 --- a/flopy/mf6/modflow/mfgwtsft.py +++ b/flopy/mf6/modflow/mfgwtsft.py @@ -1,205 +1,92 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtsft(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtsft(MFPackage): """ - ModflowGwtsft defines a sft package within a gwt6 model. + ModflowGwtsft defines a SFT package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. flow_package_name : string - * flow_package_name (string) 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). + 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). auxiliary : [string] - * auxiliary (string) 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. + 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. flow_package_auxiliary_name : string - * flow_package_auxiliary_name (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of reach cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of reach - information will be written to the listing file immediately after it - is read. - print_concentration : boolean - * print_concentration (boolean) keyword to indicate that the list of - reach concentration 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_CONCENTRATION - is specified, then concentration are printed for the last time step - of each stress period. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that reach flow terms will - be written to the file specified with "BUDGET FILEOUT" in Output - Control. - concentration_filerecord : [concfile] - * concfile (string) name of the binary output file to write - concentration information. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - packagedata : [ifno, strt, aux, boundname] - * ifno (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * strt (double) real value that defines the starting concentration for - the reach. - * aux (double) 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. - * boundname (string) 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. - reachperioddata : [ifno, reachsetting] - * ifno (integer) 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. This argument - is an index variable, which means that it should be treated as zero- - based when working with FloPy and Python. Flopy will automatically - subtract one when loading index variables and add one when writing - index variables. - * reachsetting (keystring) 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. - status : [string] - * status (string) 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. - concentration : [string] - * concentration (string) 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. - rainfall : [string] - * rainfall (string) real or character value that defines the - rainfall solute concentration :math:`(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. - evaporation : [string] - * evaporation (string) real or character value that defines the - concentration of evaporated water :math:`(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. - runoff : [string] - * runoff (string) real or character value that defines the - concentration of runoff :math:`(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. - inflow : [string] - * inflow (string) real or character value that defines the - concentration of inflow :math:`(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. - auxiliaryrecord : [auxname, auxval] - * auxname (string) 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. - * auxval (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of reach + cells. + print_input : keyword + keyword to indicate that the list of reach information will be written to the + listing file immediately after it is read. + print_concentration : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that reach flow terms will be written to the file specified + with 'budget fileout' in output control. + concentration_filerecord : (concfile) + * concfile : string + name of the binary output file to write concentration information. + + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + reachperioddata : list """ - auxiliary = ListTemplateGenerator(("gwt6", "sft", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwt6", "sft", "options", "auxiliary")) concentration_filerecord = ListTemplateGenerator( ("gwt6", "sft", "options", "concentration_filerecord") ) @@ -218,12 +105,8 @@ class ModflowGwtsft(mfpackage.MFPackage): package_abbr = "gwtsft" _package_type = "sft" dfn_file_name = "gwt-sft.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name flow_package_name", @@ -435,8 +318,8 @@ class ModflowGwtsft(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -537,8 +420,7 @@ class ModflowGwtsft(mfpackage.MFPackage): [ "block period", "name reachsetting", - "type keystring status concentration rainfall evaporation runoff " - "inflow auxiliaryrecord", + "type keystring status concentration rainfall evaporation runoff inflow auxiliaryrecord", "shape", "tagged false", "in_record true", @@ -664,9 +546,89 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtsft defines a SFT package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + flow_package_name : string + 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). + auxiliary : [string] + 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. + flow_package_auxiliary_name : string + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of reach + cells. + print_input : keyword + keyword to indicate that the list of reach information will be written to the + listing file immediately after it is read. + print_concentration : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that reach flow terms will be written to the file specified + with 'budget fileout' in output control. + concentration_filerecord : record + budget_filerecord : record + budgetcsv_filerecord : record + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + reachperioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "sft", filename, pname, loading_package, **kwargs) - # set up variables self.flow_package_name = self.build_mfdata( "flow_package_name", flow_package_name ) @@ -700,4 +662,5 @@ def __init__( ) self.packagedata = self.build_mfdata("packagedata", packagedata) self.reachperioddata = self.build_mfdata("reachperioddata", reachperioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtsrc.py b/flopy/mf6/modflow/mfgwtsrc.py index 4d6b36c939..2822d1d6c7 100644 --- a/flopy/mf6/modflow/mfgwtsrc.py +++ b/flopy/mf6/modflow/mfgwtsrc.py @@ -1,110 +1,64 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtsrc(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtsrc(MFPackage): """ - ModflowGwtsrc defines a src package within a gwt6 model. + ModflowGwtsrc defines a SRC package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. auxiliary : [string] - * auxiliary (string) 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. + 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. auxmultname : string - * auxmultname (string) name of auxiliary variable to be used as - multiplier of mass loading rate. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of mass source cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of mass - source information will be written to the listing file immediately - after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that mass source flow terms - will be written to the file specified with "BUDGET FILEOUT" in Output - Control. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. + name of auxiliary variable to be used as multiplier of mass loading rate. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of mass + source cells. + print_input : keyword + keyword to indicate that the list of mass source information will be written to + the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that mass source flow terms will be written to the file + specified with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. maxbound : integer - * maxbound (integer) integer value specifying the maximum number of - sources cells that will be specified for use during any stress - period. - stress_period_data : [cellid, smassrate, aux, boundname] - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * smassrate (double) 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. - * aux (double) 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. - * boundname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the maximum number of sources cells that will be + specified for use during any stress period. + stress_period_data : [list] """ - auxiliary = ListTemplateGenerator(("gwt6", "src", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwt6", "src", "options", "auxiliary")) ts_filerecord = ListTemplateGenerator(("gwt6", "src", "options", "ts_filerecord")) obs_filerecord = ListTemplateGenerator(("gwt6", "src", "options", "obs_filerecord")) stress_period_data = ListTemplateGenerator( @@ -113,11 +67,8 @@ class ModflowGwtsrc(mfpackage.MFPackage): package_abbr = "gwtsrc" _package_type = "src" dfn_file_name = "gwt-src.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name auxiliary", @@ -214,8 +165,8 @@ class ModflowGwtsrc(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -323,9 +274,72 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtsrc defines a SRC package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + auxiliary : [string] + 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. + auxmultname : string + name of auxiliary variable to be used as multiplier of mass loading rate. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of mass + source cells. + print_input : keyword + keyword to indicate that the list of mass source information will be written to + the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that mass source flow terms will be written to the file + specified with 'budget fileout' in output control. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + maxbound : integer + integer value specifying the maximum number of sources cells that will be + specified for use during any stress period. + stress_period_data : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "src", filename, pname, loading_package, **kwargs) - # set up variables self.auxiliary = self.build_mfdata("auxiliary", auxiliary) self.auxmultname = self.build_mfdata("auxmultname", auxmultname) self.boundnames = self.build_mfdata("boundnames", boundnames) @@ -344,4 +358,5 @@ def __init__( self.stress_period_data = self.build_mfdata( "stress_period_data", stress_period_data ) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtssm.py b/flopy/mf6/modflow/mfgwtssm.py index bffda81bd1..3f3b0654ba 100644 --- a/flopy/mf6/modflow/mfgwtssm.py +++ b/flopy/mf6/modflow/mfgwtssm.py @@ -1,84 +1,29 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtssm(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtssm(MFPackage): """ - ModflowGwtssm defines a ssm package within a gwt6 model. + ModflowGwtssm defines a SSM package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that SSM flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - sources : [pname, srctype, auxname] - * pname (string) 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. - * srctype (string) 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. - * auxname (string) 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. - fileinput : [pname, spc6_filename] - * pname (string) 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. - * spc6_filename (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that ssm flow terms will be written to the file specified + with 'budget fileout' in output control. + sources : list + fileinput : list """ @@ -87,11 +32,8 @@ class ModflowGwtssm(mfpackage.MFPackage): package_abbr = "gwtssm" _package_type = "ssm" dfn_file_name = "gwt-ssm.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name print_flows", @@ -207,11 +149,44 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtssm defines a SSM package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that ssm flow terms will be written to the file specified + with 'budget fileout' in output control. + sources : list + fileinput : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "ssm", filename, pname, loading_package, **kwargs) - # set up variables self.print_flows = self.build_mfdata("print_flows", print_flows) self.save_flows = self.build_mfdata("save_flows", save_flows) self.sources = self.build_mfdata("sources", sources) self.fileinput = self.build_mfdata("fileinput", fileinput) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfgwtuzt.py b/flopy/mf6/modflow/mfgwtuzt.py index 226b60b5d7..e405e8724c 100644 --- a/flopy/mf6/modflow/mfgwtuzt.py +++ b/flopy/mf6/modflow/mfgwtuzt.py @@ -1,191 +1,93 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowGwtuzt(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowGwtuzt(MFPackage): """ - ModflowGwtuzt defines a uzt package within a gwt6 model. + ModflowGwtuzt defines a UZT package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. flow_package_name : string - * flow_package_name (string) 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). + 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). auxiliary : [string] - * auxiliary (string) 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. + 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. flow_package_auxiliary_name : string - * flow_package_auxiliary_name (string) 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. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of unsaturated zone flow cells. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of - unsaturated zone flow information will be written to the listing file - immediately after it is read. - print_concentration : boolean - * print_concentration (boolean) keyword to indicate that the list of - UZF cell concentration 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_CONCENTRATION - is specified, then concentration are printed for the last time step - of each stress period. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that unsaturated zone flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - concentration_filerecord : [concfile] - * concfile (string) name of the binary output file to write - concentration information. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - observations : {varname:data} or continuous data - * Contains data for the obs package. Data can be stored in a dictionary - containing data for the obs package with variable names as keys and - package data as values. Data just for the observations variable is - also acceptable. See obs package documentation for more information. - packagedata : [ifno, strt, aux, boundname] - * ifno (integer) 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. This argument is an index variable, which - means that it should be treated as zero-based when working with FloPy - and Python. Flopy will automatically subtract one when loading index - variables and add one when writing index variables. - * strt (double) real value that defines the starting concentration for - the unsaturated zone flow cell. - * aux (double) 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. - * boundname (string) 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. - uztperioddata : [ifno, uztsetting] - * ifno (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * uztsetting (keystring) 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. - status : [string] - * status (string) 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. - concentration : [string] - * concentration (string) 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. - infiltration : [string] - * infiltration (string) real or character value that defines - the infiltration solute concentration :math:`(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. - uzet : [string] - * uzet (string) real or character value that defines the - concentration of unsaturated zone evapotranspiration water - :math:`(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. - auxiliaryrecord : [auxname, auxval] - * auxname (string) 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. - * auxval (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + unsaturated zone flow cells. + print_input : keyword + keyword to indicate that the list of unsaturated zone flow information will be + written to the listing file immediately after it is read. + print_concentration : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that unsaturated zone flow terms will be written to the + file specified with 'budget fileout' in output control. + concentration_filerecord : (concfile) + * concfile : string + name of the binary output file to write concentration information. + + budget_filerecord : (budgetfile) + * budgetfile : string + name of the binary output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + uztperioddata : list """ - auxiliary = ListTemplateGenerator(("gwt6", "uzt", "options", "auxiliary")) + auxiliary = ArrayTemplateGenerator(("gwt6", "uzt", "options", "auxiliary")) concentration_filerecord = ListTemplateGenerator( ("gwt6", "uzt", "options", "concentration_filerecord") ) @@ -202,12 +104,8 @@ class ModflowGwtuzt(mfpackage.MFPackage): package_abbr = "gwtuzt" _package_type = "uzt" dfn_file_name = "gwt-uzt.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name flow_package_name", @@ -419,8 +317,8 @@ class ModflowGwtuzt(mfpackage.MFPackage): "tagged true", "optional true", "construct_package obs", - "construct_data continuous", - "parameter_name observations", + "construct_data observations", + "parameter_name continuous", ], [ "block options", @@ -627,9 +525,90 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowGwtuzt defines a UZT package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + flow_package_name : string + 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). + auxiliary : [string] + 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. + flow_package_auxiliary_name : string + 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. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + unsaturated zone flow cells. + print_input : keyword + keyword to indicate that the list of unsaturated zone flow information will be + written to the listing file immediately after it is read. + print_concentration : keyword + 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. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that unsaturated zone flow terms will be written to the + file specified with 'budget fileout' in output control. + concentration_filerecord : record + budget_filerecord : record + budgetcsv_filerecord : record + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + observations : record obs6 filein obs6_filename + Contains data for the obs package. Data can be passed as a dictionary to the + obs package with variable names as keys and package data as values. Data for + the observations variable is also acceptable. See obs package documentation for + more information. + packagedata : [list] + uztperioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "uzt", filename, pname, loading_package, **kwargs) - # set up variables self.flow_package_name = self.build_mfdata( "flow_package_name", flow_package_name ) @@ -663,4 +642,5 @@ def __init__( ) self.packagedata = self.build_mfdata("packagedata", packagedata) self.uztperioddata = self.build_mfdata("uztperioddata", uztperioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfims.py b/flopy/mf6/modflow/mfims.py index 0b339e2762..1dc31330c8 100644 --- a/flopy/mf6/modflow/mfims.py +++ b/flopy/mf6/modflow/mfims.py @@ -1,365 +1,325 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowIms(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowIms(MFPackage): """ - ModflowIms defines a ims package. + ModflowIms defines a IMS package. Parameters ---------- - simulation : MFSimulation - Simulation that this package is a part of. Package is automatically - added to simulation when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. print_option : string - * print_option (string) 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. + 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. complexity : string - * complexity (string) 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. - csv_output_filerecord : [csvfile] - * csvfile (string) 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. - csv_outer_output_filerecord : [outer_csvfile] - * outer_csvfile (string) 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. - csv_inner_output_filerecord : [inner_csvfile] - * inner_csvfile (string) 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. - no_ptcrecord : [no_ptc_option] - * no_ptc_option (string) 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. - ats_outer_maximum_fraction : double - * ats_outer_maximum_fraction (double) 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. - outer_hclose : double - * outer_hclose (double) 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. - outer_dvclose : double - * outer_dvclose (double) 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. - outer_rclosebnd : double - * outer_rclosebnd (double) 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. + 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. + csv_output_filerecord : (csvfile) + * csvfile : string + 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. + + csv_outer_output_filerecord : (outer_csvfile) + * outer_csvfile : string + 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. + + csv_inner_output_filerecord : (inner_csvfile) + * inner_csvfile : string + 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. + + no_ptcrecord : (no_ptc, no_ptc_option) + * no_ptc : keyword + 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. + * no_ptc_option : string + 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. + + ats_outer_maximum_fraction : double precision + 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. + outer_hclose : double precision + 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. + outer_dvclose : double precision + 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. + outer_rclosebnd : double precision + 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. outer_maximum : integer - * outer_maximum (integer) 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. + 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. under_relaxation : string - * under_relaxation (string) 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. - under_relaxation_gamma : double - * under_relaxation_gamma (double) 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. - under_relaxation_theta : double - * under_relaxation_theta (double) 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. - under_relaxation_kappa : double - * under_relaxation_kappa (double) 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. - under_relaxation_momentum : double - * under_relaxation_momentum (double) 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. + 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. + under_relaxation_gamma : double precision + 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. + under_relaxation_theta : double precision + 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. + under_relaxation_kappa : double precision + 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. + under_relaxation_momentum : double precision + 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. backtracking_number : integer - * backtracking_number (integer) 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. - backtracking_tolerance : double - * backtracking_tolerance (double) 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:math:`^6`; a - value of 10:math:`^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. - backtracking_reduction_factor : double - * backtracking_reduction_factor (double) 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. - backtracking_residual_limit : double - * backtracking_residual_limit (double) 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. + 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. + backtracking_tolerance : double precision + 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:math:`^6`; a value of + 10:math:`^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. + backtracking_reduction_factor : double precision + 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. + backtracking_residual_limit : double precision + 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. inner_maximum : integer - * inner_maximum (integer) 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. - inner_hclose : double - * inner_hclose (double) 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. - inner_dvclose : double - * inner_dvclose (double) 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. - rcloserecord : [inner_rclose, rclose_option] - * inner_rclose (double) 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 MODFLOW 6 length and time units. - Usually a value of :math:`1.0 \\times 10^{-1}` is sufficient for the - flow-residual criteria when meters and seconds are the defined - MODFLOW 6 length and time. - * rclose_option (string) 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 (Hill, 1990)). 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 MODFLOW 6 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 :math:`1.0 \\times 10^{-4}` and convergence is achieved for - a given inner (linear) iteration when :math:`\\Delta h \\le` - INNER_DVCLOSE and the current L-2 Norm is :math:`\\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. + 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. + inner_hclose : double precision + 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. + inner_dvclose : double precision + 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. + rcloserecord : (inner_rclose, rclose_option) + * inner_rclose : double precision + 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 :math:`1.0 times 10^{-1}` is sufficient for the flow-residual criteria + when meters and seconds are the defined mf length and time. + * rclose_option : string + 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 :math:`1.0 times 10^{-4}` and convergence is achieved for + a given inner (linear) iteration when :math:`Delta h le` INNER_DVCLOSE and the + current L-2 Norm is :math:`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. + linear_acceleration : string - * linear_acceleration (string) 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. - relaxation_factor : double - * relaxation_factor (double) 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. + 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. + relaxation_factor : double precision + 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. preconditioner_levels : integer - * preconditioner_levels (integer) 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. - preconditioner_drop_tolerance : double - * preconditioner_drop_tolerance (double) 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 :math:`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 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. + preconditioner_drop_tolerance : double precision + 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 :math:`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. number_orthogonalizations : integer - * number_orthogonalizations (integer) 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 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. scaling_method : string - * scaling_method (string) 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. + 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. reordering_method : string - * reordering_method (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. """ @@ -377,12 +337,8 @@ class ModflowIms(mfpackage.MFPackage): package_abbr = "ims" _package_type = "ims" dfn_file_name = "sln-ims.dfn" - dfn = [ - [ - "header", - ["solution_package", "*"], - ], + ["header", ["solution_package", "*"]], [ "block options", "name print_option", @@ -762,9 +718,315 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowIms defines a IMS package. + + Parameters + ---------- + simulation + Simulation that this package is a part of. Package is automatically + added to simulation when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + print_option : string + 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. + complexity : string + 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. + csv_output_filerecord : record + csv_outer_output_filerecord : record + csv_inner_output_filerecord : record + no_ptcrecord : (no_ptc, no_ptc_option) + * no_ptc : keyword + 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. + * no_ptc_option : string + 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. + + ats_outer_maximum_fraction : double precision + 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. + outer_hclose : double precision + 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. + outer_dvclose : double precision + 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. + outer_rclosebnd : double precision + 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. + outer_maximum : integer + 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. + under_relaxation : string + 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. + under_relaxation_gamma : double precision + 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. + under_relaxation_theta : double precision + 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. + under_relaxation_kappa : double precision + 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. + under_relaxation_momentum : double precision + 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. + backtracking_number : integer + 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. + backtracking_tolerance : double precision + 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:math:`^6`; a value of + 10:math:`^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. + backtracking_reduction_factor : double precision + 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. + backtracking_residual_limit : double precision + 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. + inner_maximum : integer + 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. + inner_hclose : double precision + 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. + inner_dvclose : double precision + 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. + rcloserecord : (inner_rclose, rclose_option) + * inner_rclose : double precision + 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 :math:`1.0 times 10^{-1}` is sufficient for the flow-residual criteria + when meters and seconds are the defined mf length and time. + * rclose_option : string + 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 :math:`1.0 times 10^{-4}` and convergence is achieved for + a given inner (linear) iteration when :math:`Delta h le` INNER_DVCLOSE and the + current L-2 Norm is :math:`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. + + linear_acceleration : string + 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. + relaxation_factor : double precision + 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. + preconditioner_levels : integer + 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. + preconditioner_drop_tolerance : double precision + 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 :math:`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. + number_orthogonalizations : integer + 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. + scaling_method : string + 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. + reordering_method : string + 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. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(simulation, "ims", filename, pname, loading_package, **kwargs) - # set up variables self.print_option = self.build_mfdata("print_option", print_option) self.complexity = self.build_mfdata("complexity", complexity) self.csv_output_filerecord = self.build_mfdata( @@ -832,4 +1094,5 @@ def __init__( self.reordering_method = self.build_mfdata( "reordering_method", reordering_method ) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfmvr.py b/flopy/mf6/modflow/mfmvr.py index 8c6befa858..04d6fd6d51 100644 --- a/flopy/mf6/modflow/mfmvr.py +++ b/flopy/mf6/modflow/mfmvr.py @@ -1,114 +1,42 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowMvr(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowMvr(MFPackage): """ - ModflowMvr defines a mvr package. This package can only be used to move - water between two different models. To move water between two packages - in the same model use the "model level" mover package (ex. ModflowGwfmvr). + ModflowMvr defines a MVR package. Parameters ---------- - parent_model_or_package : MFModel/MFPackage - Parent_model_or_package that this package is a part of. Package is automatically - added to parent_model_or_package when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of MVR - information will be written to the listing file immediately after it - is read. - print_flows : boolean - * print_flows (boolean) 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. - modelnames : boolean - * modelnames (boolean) 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. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. + print_input : keyword + keyword to indicate that the list of mvr information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + modelnames : keyword + 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. + budget_filerecord : record + budgetcsv_filerecord : record maxmvr : integer - * maxmvr (integer) integer value specifying the maximum number of water - mover entries that will specified for any stress period. + integer value specifying the maximum number of water mover entries that will + specified for any stress period. maxpackages : integer - * maxpackages (integer) integer value specifying the number of unique - packages that are included in this water mover input file. - packages : [mname, pname] - * mname (string) name of model containing the package. Model names are - assigned by the user in the simulation name file. - * pname (string) 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. - perioddata : [mname1, pname1, id1, mname2, pname2, id2, mvrtype, value] - * mname1 (string) name of model containing the package, PNAME1. - * pname1 (string) 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. - * id1 (integer) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - * mname2 (string) name of model containing the package, PNAME2. - * pname2 (string) 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. - * id2 (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * mvrtype (string) 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, :math:`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. - * value (double) is the value to be used in the equation for - calculating the amount of water to move. For the "FACTOR" option, - VALUE is the :math:`\\alpha` factor. For the remaining options, VALUE - is the specified flow rate, :math:`Q_S`. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the number of unique packages that are included in + this water mover input file. + packages : [list] + perioddata : [list] """ @@ -121,11 +49,8 @@ class ModflowMvr(mfpackage.MFPackage): package_abbr = "mvr" _package_type = "mvr" dfn_file_name = "gwf-mvr.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name print_input", @@ -373,11 +298,56 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowMvr defines a MVR package. + + Parameters + ---------- + parent_model_or_package + Parent_model_or_package that this package is a part of. Package is automatically + added to parent_model_or_package when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + print_input : keyword + keyword to indicate that the list of mvr information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + modelnames : keyword + 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. + budget_filerecord : record + budgetcsv_filerecord : record + maxmvr : integer + integer value specifying the maximum number of water mover entries that will + specified for any stress period. + maxpackages : integer + integer value specifying the number of unique packages that are included in + this water mover input file. + packages : [list] + perioddata : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__( parent_model_or_package, "mvr", filename, pname, loading_package, **kwargs ) - # set up variables self.print_input = self.build_mfdata("print_input", print_input) self.print_flows = self.build_mfdata("print_flows", print_flows) self.modelnames = self.build_mfdata("modelnames", modelnames) @@ -391,10 +361,11 @@ def __init__( self.maxpackages = self.build_mfdata("maxpackages", maxpackages) self.packages = self.build_mfdata("packages", packages) self.perioddata = self.build_mfdata("perioddata", perioddata) + self._init_complete = True -class MvrPackages(mfpackage.MFChildPackages): +class MvrPackages(MFChildPackages): """ MvrPackages is a container class for the ModflowMvr class. @@ -405,8 +376,9 @@ class MvrPackages(mfpackage.MFChildPackages): packages attached to the same parent package. See ModflowMvr init documentation for definition of parameters. append_package - Adds a new ModflowGwfmvr package to the container. See ModflowGwfmvr + Adds a new ModflowMvr package to the container. See ModflowMvr init documentation for definition of parameters. + """ package_abbr = "mvrpackages" @@ -456,7 +428,7 @@ def append_package( filename=None, pname=None, ): - new_package = ModflowGwfmvr( + new_package = ModflowMvr( self._cpparent, print_input=print_input, print_flows=print_flows, diff --git a/flopy/mf6/modflow/mfmvt.py b/flopy/mf6/modflow/mfmvt.py index 6133942727..aff6acdcd7 100644 --- a/flopy/mf6/modflow/mfmvt.py +++ b/flopy/mf6/modflow/mfmvt.py @@ -1,52 +1,32 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowMvt(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowMvt(MFPackage): """ - ModflowMvt defines a mvt package. + ModflowMvt defines a MVT package. Parameters ---------- - parent_model_or_package : MFModel/MFPackage - Parent_model_or_package that this package is a part of. Package is automatically - added to parent_model_or_package when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of mover - information will be written to the listing file immediately after it - is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that lake flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the binary output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + print_input : keyword + keyword to indicate that the list of mover information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that lake flow terms will be written to the file specified + with 'budget fileout' in output control. + budget_filerecord : record + budgetcsv_filerecord : record """ @@ -57,11 +37,8 @@ class ModflowMvt(mfpackage.MFPackage): package_abbr = "mvt" _package_type = "mvt" dfn_file_name = "gwt-mvt.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name print_input", @@ -168,11 +145,46 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowMvt defines a MVT package. + + Parameters + ---------- + parent_model_or_package + Parent_model_or_package that this package is a part of. Package is automatically + added to parent_model_or_package when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + print_input : keyword + keyword to indicate that the list of mover information will be written to the + listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that lake flow terms will be written to the file specified + with 'budget fileout' in output control. + budget_filerecord : record + budgetcsv_filerecord : record + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__( parent_model_or_package, "mvt", filename, pname, loading_package, **kwargs ) - # set up variables self.print_input = self.build_mfdata("print_input", print_input) self.print_flows = self.build_mfdata("print_flows", print_flows) self.save_flows = self.build_mfdata("save_flows", save_flows) @@ -182,10 +194,11 @@ def __init__( self.budgetcsv_filerecord = self.build_mfdata( "budgetcsv_filerecord", budgetcsv_filerecord ) + self._init_complete = True -class MvtPackages(mfpackage.MFChildPackages): +class MvtPackages(MFChildPackages): """ MvtPackages is a container class for the ModflowMvt class. @@ -196,8 +209,9 @@ class MvtPackages(mfpackage.MFChildPackages): packages attached to the same parent package. See ModflowMvt init documentation for definition of parameters. append_package - Adds a new ModflowGwtmvt package to the container. See ModflowGwtmvt + Adds a new ModflowMvt package to the container. See ModflowMvt init documentation for definition of parameters. + """ package_abbr = "mvtpackages" @@ -235,7 +249,7 @@ def append_package( filename=None, pname=None, ): - new_package = ModflowGwtmvt( + new_package = ModflowMvt( self._cpparent, print_input=print_input, print_flows=print_flows, diff --git a/flopy/mf6/modflow/mfnam.py b/flopy/mf6/modflow/mfnam.py index ca46a300f6..bb9bdb72f8 100644 --- a/flopy/mf6/modflow/mfnam.py +++ b/flopy/mf6/modflow/mfnam.py @@ -1,93 +1,59 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowNam(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowNam(MFPackage): """ - ModflowNam defines a nam package. + ModflowNam defines a NAM package. Parameters ---------- - simulation : MFSimulation - Simulation that this package is a part of. Package is automatically - added to simulation when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - continue_ : boolean - * continue (boolean) keyword flag to indicate that the simulation - should continue even if one or more solutions do not converge. - nocheck : boolean - * nocheck (boolean) keyword flag to indicate that the model input check - routines should not be called prior to each time step. Checks are - performed by default. + continue_ : keyword + keyword flag to indicate that the simulation should continue even if one or + more solutions do not converge. + nocheck : keyword + keyword flag to indicate that the model input check routines should not be + called prior to each time step. checks are performed by default. memory_print_option : string - * memory_print_option (string) 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. + 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. profile_option : string - * profile_option (string) 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. + 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. maxerrors : integer - * maxerrors (integer) maximum number of errors that will be stored and - printed. - print_input : boolean - * print_input (boolean) 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. - hpc_data : {varname:data} or hpc_data data - * Contains data for the hpc package. Data can be stored in a dictionary - containing data for the hpc package with variable names as keys and - package data as values. Data just for the hpc_data variable is also - acceptable. See hpc package documentation for more information. + maximum number of errors that will be stored and printed. + print_input : keyword + 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. + hpc_data : record hpc6 filein hpc6_filename + Contains data for the hpc package. Data can be passed as a dictionary to the + hpc package with variable names as keys and package data as values. Data for + the hpc_data variable is also acceptable. See hpc package documentation for + more information. tdis6 : string - * tdis6 (string) is the name of the Temporal Discretization (TDIS) - Input File. - models : [mtype, mfname, mname] - * mtype (string) is the type of model to add to simulation. - * mfname (string) is the file name of the model name file. - * mname (string) 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. - exchanges : [exgtype, exgfile, exgmnamea, exgmnameb] - * exgtype (string) is the exchange type. - * exgfile (string) is the input file for the exchange. - * exgmnamea (string) is the name of the first model that is part of - this exchange. - * exgmnameb (string) is the name of the second model that is part of - this exchange. + is the name of the temporal discretization (tdis) input file. + models : list + is the list of model types, model name files, and model names. + exchanges : list + is the list of exchange types, exchange files, and model names. mxiter : integer - * mxiter (integer) 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. - solutiongroup : [slntype, slnfname, slnmnames] - * slntype (string) is the type of solution. The Integrated Model - Solution (IMS6) and Explicit Model Solution (EMS6) are the only - supported options in this version. - * slnfname (string) name of file containing solution input. - * slnmnames (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + solutiongroup : list + is the list of solution types and models in the solution. """ @@ -98,11 +64,8 @@ class ModflowNam(mfpackage.MFPackage): package_abbr = "nam" _package_type = "nam" dfn_file_name = "sim-nam.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name continue", @@ -333,6 +296,7 @@ def __init__( profile_option=None, maxerrors=None, print_input=None, + hpc_data=None, tdis6=None, models=None, exchanges=None, @@ -342,9 +306,71 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowNam defines a NAM package. + + Parameters + ---------- + simulation + Simulation that this package is a part of. Package is automatically + added to simulation when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + continue_ : keyword + keyword flag to indicate that the simulation should continue even if one or + more solutions do not converge. + nocheck : keyword + keyword flag to indicate that the model input check routines should not be + called prior to each time step. checks are performed by default. + memory_print_option : string + 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. + profile_option : string + 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. + maxerrors : integer + maximum number of errors that will be stored and printed. + print_input : keyword + 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. + hpc_data : record hpc6 filein hpc6_filename + Contains data for the hpc package. Data can be passed as a dictionary to the + hpc package with variable names as keys and package data as values. Data for + the hpc_data variable is also acceptable. See hpc package documentation for + more information. + tdis6 : string + is the name of the temporal discretization (tdis) input file. + models : list + is the list of model types, model name files, and model names. + exchanges : list + is the list of exchange types, exchange files, and model names. + mxiter : integer + 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. + solutiongroup : list + is the list of solution types and models in the solution. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(simulation, "nam", filename, pname, loading_package, **kwargs) - # set up variables self.continue_ = self.build_mfdata("continue", continue_) self.nocheck = self.build_mfdata("nocheck", nocheck) self.memory_print_option = self.build_mfdata( @@ -359,4 +385,5 @@ def __init__( self.exchanges = self.build_mfdata("exchanges", exchanges) self.mxiter = self.build_mfdata("mxiter", mxiter) self.solutiongroup = self.build_mfdata("solutiongroup", solutiongroup) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfprt.py b/flopy/mf6/modflow/mfprt.py index a56e90f0bd..e11902f078 100644 --- a/flopy/mf6/modflow/mfprt.py +++ b/flopy/mf6/modflow/mfprt.py @@ -1,66 +1,37 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfmodel -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowPrt(mfmodel.MFModel): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfmodel import MFModel + + +class ModflowPrt(MFModel): """ - Modflowprt defines a prt model + ModflowPrt defines a PRT model. Parameters ---------- - modelname : string - name of the model - model_nam_file : string - relative path to the model name file from model working folder - version : string - version of modflow - exe_name : string - model executable name - model_ws : string - model working folder path - sim : MFSimulation - Simulation that this model is a part of. Model is automatically - added to simulation when it is initialized. list : string - * list (string) 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". - print_input : boolean - * print_input (boolean) keyword to indicate that the list of all model - stress package information will be written to the listing file - immediately after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that all model package flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - packages : [ftype, fname, pname] - * ftype (string) 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. - * fname (string) 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. - * pname (string) 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. + 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'. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that all model package flow terms will be written to the + file specified with 'budget fileout' in output control. + packages : list + Methods ------- @@ -86,6 +57,46 @@ def __init__( save_flows=None, **kwargs, ): + """ + ModflowPrt defines a PRT model. + + Parameters + ---------- + modelname : string + name of the model + model_nam_file : string + relative path to the model name file from model working folder + version : string + version of modflow + exe_name : string + model executable name + model_ws : string + model working folder path + sim : MFSimulation + Simulation that this model is a part of. Model is automatically + added to simulation when it is initialized. + + list : string + 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'. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that all model package flow terms will be written to the + file specified with 'budget fileout' in output control. + packages : list + + """ + super().__init__( simulation, model_type="prt6", @@ -98,13 +109,12 @@ def __init__( ) self.name_file.list.set_data(list) - self.name_file.print_input.set_data(print_input) - self.name_file.print_flows.set_data(print_flows) - self.name_file.save_flows.set_data(save_flows) - self.list = self.name_file.list + self.name_file.print_input.set_data(print_input) self.print_input = self.name_file.print_input + self.name_file.print_flows.set_data(print_flows) self.print_flows = self.name_file.print_flows + self.name_file.save_flows.set_data(save_flows) self.save_flows = self.name_file.save_flows @classmethod @@ -117,10 +127,10 @@ def load( version="mf6", exe_name="mf6", strict=True, - model_rel_path=".", + model_rel_path=curdir, load_only=None, ): - return mfmodel.MFModel.load_base( + return MFModel.load_base( cls, simulation, structure, diff --git a/flopy/mf6/modflow/mfprtdis.py b/flopy/mf6/modflow/mfprtdis.py index ca94443697..bdc706d1fc 100644 --- a/flopy/mf6/modflow/mfprtdis.py +++ b/flopy/mf6/modflow/mfprtdis.py @@ -1,96 +1,84 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowPrtdis(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowPrtdis(MFPackage): """ - ModflowPrtdis defines a dis package within a prt6 model. + ModflowPrtdis defines a DIS package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. length_units : string - * length_units (string) is the length units used for this model. Values - can be "FEET", "METERS", or "CENTIMETERS". If not specified, the - default is "UNKNOWN". - nogrb : boolean - * nogrb (boolean) keyword to deactivate writing of the binary grid - file. - xorigin : double - * xorigin (double) 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. - yorigin : double - * yorigin (double) 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. - angrot : double - * angrot (double) 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. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. - export_array_netcdf : boolean - * export_array_netcdf (boolean) keyword that specifies input griddata - arrays should be written to the model output netcdf file. - packagedata : {varname:data} or packagedata data - * Contains data for the ncf package. Data can be stored in a dictionary - containing data for the ncf package with variable names as keys and - package data as values. Data just for the packagedata variable is - also acceptable. See ncf package documentation for more information. + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : (grb6_filename) + * grb6_filename : string + 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'. + + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + packagedata : record ncf6 filein ncf6_filename + Contains data for the ncf package. Data can be passed as a dictionary to the + ncf package with variable names as keys and package data as values. Data for + the packagedata variable is also acceptable. See ncf package documentation for + more information. nlay : integer - * nlay (integer) is the number of layers in the model grid. + is the number of layers in the model grid. nrow : integer - * nrow (integer) is the number of rows in the model grid. + is the number of rows in the model grid. ncol : integer - * ncol (integer) is the number of columns in the model grid. - delr : [double] - * delr (double) is the column spacing in the row direction. - delc : [double] - * delc (double) is the row spacing in the column direction. - top : [double] - * top (double) is the top elevation for each cell in the top model - layer. - botm : [double] - * botm (double) is the bottom elevation for each cell. + is the number of columns in the model grid. + delr : [double precision] + is the column spacing in the row direction. + delc : [double precision] + is the row spacing in the column direction. + top : [double precision] + is the top elevation for each cell in the top model layer. + botm : [double precision] + is the bottom elevation for each cell. idomain : [integer] - * idomain (integer) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. """ + grb_filerecord = ListTemplateGenerator(("prt6", "dis", "options", "grb_filerecord")) ncf_filerecord = ListTemplateGenerator(("prt6", "dis", "options", "ncf_filerecord")) delr = ArrayTemplateGenerator(("prt6", "dis", "griddata", "delr")) delc = ArrayTemplateGenerator(("prt6", "dis", "griddata", "delc")) @@ -100,11 +88,8 @@ class ModflowPrtdis(mfpackage.MFPackage): package_abbr = "prtdis" _package_type = "dis" dfn_file_name = "prt-dis.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name length_units", @@ -119,6 +104,44 @@ class ModflowPrtdis(mfpackage.MFPackage): "reader urword", "optional true", ], + [ + "block options", + "name grb_filerecord", + "type record grb6 fileout grb6_filename", + "reader urword", + "tagged true", + "optional true", + ], + [ + "block options", + "name grb6", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + "extended true", + ], + [ + "block options", + "name fileout", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + ], + [ + "block options", + "name grb6_filename", + "type string", + "preserve_case true", + "in_record true", + "reader urword", + "optional false", + "tagged false", + "extended true", + ], [ "block options", "name xorigin", @@ -201,7 +224,7 @@ class ModflowPrtdis(mfpackage.MFPackage): "type integer", "reader urword", "optional false", - "default_value 1", + "default 1", ], [ "block dimensions", @@ -209,7 +232,7 @@ class ModflowPrtdis(mfpackage.MFPackage): "type integer", "reader urword", "optional false", - "default_value 2", + "default 2", ], [ "block dimensions", @@ -217,7 +240,7 @@ class ModflowPrtdis(mfpackage.MFPackage): "type integer", "reader urword", "optional false", - "default_value 2", + "default 2", ], [ "block griddata", @@ -225,7 +248,7 @@ class ModflowPrtdis(mfpackage.MFPackage): "type double precision", "shape (ncol)", "reader readarray", - "default_value 1.0", + "default 1.0", ], [ "block griddata", @@ -233,7 +256,7 @@ class ModflowPrtdis(mfpackage.MFPackage): "type double precision", "shape (nrow)", "reader readarray", - "default_value 1.0", + "default 1.0", ], [ "block griddata", @@ -241,7 +264,7 @@ class ModflowPrtdis(mfpackage.MFPackage): "type double precision", "shape (ncol, nrow)", "reader readarray", - "default_value 1.0", + "default 1.0", ], [ "block griddata", @@ -250,7 +273,7 @@ class ModflowPrtdis(mfpackage.MFPackage): "shape (ncol, nrow, nlay)", "reader readarray", "layered true", - "default_value 0.", + "default 0.", ], [ "block griddata", @@ -269,6 +292,7 @@ def __init__( loading_package=False, length_units=None, nogrb=None, + grb_filerecord=None, xorigin=None, yorigin=None, angrot=None, @@ -287,11 +311,90 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowPrtdis defines a DIS package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + length_units : string + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : record + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + packagedata : record ncf6 filein ncf6_filename + Contains data for the ncf package. Data can be passed as a dictionary to the + ncf package with variable names as keys and package data as values. Data for + the packagedata variable is also acceptable. See ncf package documentation for + more information. + nlay : integer + is the number of layers in the model grid. + nrow : integer + is the number of rows in the model grid. + ncol : integer + is the number of columns in the model grid. + delr : [double precision] + is the column spacing in the row direction. + delc : [double precision] + is the row spacing in the column direction. + top : [double precision] + is the top elevation for each cell in the top model layer. + botm : [double precision] + is the bottom elevation for each cell. + idomain : [integer] + 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. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "dis", filename, pname, loading_package, **kwargs) - # set up variables self.length_units = self.build_mfdata("length_units", length_units) self.nogrb = self.build_mfdata("nogrb", nogrb) + self.grb_filerecord = self.build_mfdata("grb_filerecord", grb_filerecord) self.xorigin = self.build_mfdata("xorigin", xorigin) self.yorigin = self.build_mfdata("yorigin", yorigin) self.angrot = self.build_mfdata("angrot", angrot) @@ -313,4 +416,5 @@ def __init__( self.top = self.build_mfdata("top", top) self.botm = self.build_mfdata("botm", botm) self.idomain = self.build_mfdata("idomain", idomain) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfprtdisv.py b/flopy/mf6/modflow/mfprtdisv.py index e71196977b..081782d021 100644 --- a/flopy/mf6/modflow/mfprtdisv.py +++ b/flopy/mf6/modflow/mfprtdisv.py @@ -1,124 +1,87 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowPrtdisv(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowPrtdisv(MFPackage): """ - ModflowPrtdisv defines a disv package within a prt6 model. + ModflowPrtdisv defines a DISV package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. length_units : string - * length_units (string) is the length units used for this model. Values - can be "FEET", "METERS", or "CENTIMETERS". If not specified, the - default is "UNKNOWN". - nogrb : boolean - * nogrb (boolean) keyword to deactivate writing of the binary grid - file. - xorigin : double - * xorigin (double) 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. - yorigin : double - * yorigin (double) 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. - angrot : double - * angrot (double) 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. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. - export_array_netcdf : boolean - * export_array_netcdf (boolean) keyword that specifies input griddata - arrays should be written to the model output netcdf file. - packagedata : {varname:data} or packagedata data - * Contains data for the ncf package. Data can be stored in a dictionary - containing data for the ncf package with variable names as keys and - package data as values. Data just for the packagedata variable is - also acceptable. See ncf package documentation for more information. + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : (grb6_filename) + * grb6_filename : string + defines a binary grid output file. + + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + packagedata : record ncf6 filein ncf6_filename + Contains data for the ncf package. Data can be passed as a dictionary to the + ncf package with variable names as keys and package data as values. Data for + the packagedata variable is also acceptable. See ncf package documentation for + more information. nlay : integer - * nlay (integer) is the number of layers in the model grid. + is the number of layers in the model grid. ncpl : integer - * ncpl (integer) is the number of cells per layer. This is a constant - value for the grid and it applies to all layers. + is the number of cells per layer. this is a constant value for the grid and it + applies to all layers. nvert : integer - * nvert (integer) is the total number of (x, y) vertex pairs used to - characterize the horizontal configuration of the model grid. - top : [double] - * top (double) is the top elevation for each cell in the top model - layer. - botm : [double] - * botm (double) is the bottom elevation for each cell. + is the total number of (x, y) vertex pairs used to characterize the horizontal + configuration of the model grid. + top : [double precision] + is the top elevation for each cell in the top model layer. + botm : [double precision] + is the bottom elevation for each cell. idomain : [integer] - * idomain (integer) 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. - vertices : [iv, xv, yv] - * iv (integer) is the vertex number. Records in the VERTICES block must - be listed in consecutive order from 1 to NVERT. This argument is an - index variable, which means that it should be treated as zero-based - when working with FloPy and Python. Flopy will automatically subtract - one when loading index variables and add one when writing index - variables. - * xv (double) is the x-coordinate for the vertex. - * yv (double) is the y-coordinate for the vertex. - cell2d : [icell2d, xc, yc, ncvert, icvert] - * icell2d (integer) is the CELL2D number. Records in the CELL2D block - must be listed in consecutive order from the first to the last. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * xc (double) is the x-coordinate for the cell center. - * yc (double) is the y-coordinate for the cell center. - * ncvert (integer) is the number of vertices required to define the - cell. There may be a different number of vertices for each cell. - * icvert (integer) 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. This argument is an index variable, which means that - it should be treated as zero-based when working with FloPy and - Python. Flopy will automatically subtract one when loading index - variables and add one when writing index variables. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + vertices : [list] + cell2d : [list] """ + grb_filerecord = ListTemplateGenerator( + ("prt6", "disv", "options", "grb_filerecord") + ) ncf_filerecord = ListTemplateGenerator( ("prt6", "disv", "options", "ncf_filerecord") ) @@ -130,11 +93,8 @@ class ModflowPrtdisv(mfpackage.MFPackage): package_abbr = "prtdisv" _package_type = "disv" dfn_file_name = "prt-disv.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name length_units", @@ -149,6 +109,44 @@ class ModflowPrtdisv(mfpackage.MFPackage): "reader urword", "optional true", ], + [ + "block options", + "name grb_filerecord", + "type record grb6 fileout grb6_filename", + "reader urword", + "tagged true", + "optional true", + ], + [ + "block options", + "name grb6", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + "extended true", + ], + [ + "block options", + "name fileout", + "type keyword", + "in_record true", + "reader urword", + "tagged true", + "optional false", + ], + [ + "block options", + "name grb6_filename", + "type string", + "preserve_case true", + "in_record true", + "reader urword", + "optional false", + "tagged false", + "extended true", + ], [ "block options", "name xorigin", @@ -370,6 +368,7 @@ def __init__( loading_package=False, length_units=None, nogrb=None, + grb_filerecord=None, xorigin=None, yorigin=None, angrot=None, @@ -388,11 +387,93 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowPrtdisv defines a DISV package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + length_units : string + is the length units used for this model. values can be 'feet', 'meters', or + 'centimeters'. if not specified, the default is 'unknown'. + nogrb : keyword + keyword to deactivate writing of the binary grid file. + grb_filerecord : record + xorigin : double precision + 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. + yorigin : double precision + 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. + angrot : double precision + 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + export_array_netcdf : keyword + keyword that specifies input griddata arrays should be written to the model + output netcdf file. + packagedata : record ncf6 filein ncf6_filename + Contains data for the ncf package. Data can be passed as a dictionary to the + ncf package with variable names as keys and package data as values. Data for + the packagedata variable is also acceptable. See ncf package documentation for + more information. + nlay : integer + is the number of layers in the model grid. + ncpl : integer + is the number of cells per layer. this is a constant value for the grid and it + applies to all layers. + nvert : integer + is the total number of (x, y) vertex pairs used to characterize the horizontal + configuration of the model grid. + top : [double precision] + is the top elevation for each cell in the top model layer. + botm : [double precision] + is the bottom elevation for each cell. + idomain : [integer] + 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. + vertices : [list] + cell2d : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "disv", filename, pname, loading_package, **kwargs) - # set up variables self.length_units = self.build_mfdata("length_units", length_units) self.nogrb = self.build_mfdata("nogrb", nogrb) + self.grb_filerecord = self.build_mfdata("grb_filerecord", grb_filerecord) self.xorigin = self.build_mfdata("xorigin", xorigin) self.yorigin = self.build_mfdata("yorigin", yorigin) self.angrot = self.build_mfdata("angrot", angrot) @@ -414,4 +495,5 @@ def __init__( self.idomain = self.build_mfdata("idomain", idomain) self.vertices = self.build_mfdata("vertices", vertices) self.cell2d = self.build_mfdata("cell2d", cell2d) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfprtfmi.py b/flopy/mf6/modflow/mfprtfmi.py index 91781903e2..035420fc17 100644 --- a/flopy/mf6/modflow/mfprtfmi.py +++ b/flopy/mf6/modflow/mfprtfmi.py @@ -1,42 +1,22 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowPrtfmi(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowPrtfmi(MFPackage): """ - ModflowPrtfmi defines a fmi package within a prt6 model. + ModflowPrtfmi defines a FMI package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - save_flows : boolean - * save_flows (boolean) keyword to indicate that FMI flow terms will be - written to the file specified with "BUDGET FILEOUT" in Output - Control. - packagedata : [flowtype, fname] - * flowtype (string) 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. - * fname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + save_flows : keyword + keyword to indicate that fmi flow terms will be written to the file specified + with 'budget fileout' in output control. + packagedata : list """ @@ -44,11 +24,8 @@ class ModflowPrtfmi(mfpackage.MFPackage): package_abbr = "prtfmi" _package_type = "fmi" dfn_file_name = "prt-fmi.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name save_flows", @@ -102,9 +79,35 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowPrtfmi defines a FMI package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + save_flows : keyword + keyword to indicate that fmi flow terms will be written to the file specified + with 'budget fileout' in output control. + packagedata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "fmi", filename, pname, loading_package, **kwargs) - # set up variables self.save_flows = self.build_mfdata("save_flows", save_flows) self.packagedata = self.build_mfdata("packagedata", packagedata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfprtmip.py b/flopy/mf6/modflow/mfprtmip.py index edfcaafc39..c89101861f 100644 --- a/flopy/mf6/modflow/mfprtmip.py +++ b/flopy/mf6/modflow/mfprtmip.py @@ -1,57 +1,43 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowPrtmip(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowPrtmip(MFPackage): """ - ModflowPrtmip defines a mip package within a prt6 model. + ModflowPrtmip defines a MIP package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - export_array_ascii : boolean - * export_array_ascii (boolean) keyword that specifies input griddata - arrays should be written to layered ascii output files. - porosity : [double] - * porosity (double) is the aquifer porosity. - retfactor : [double] - * retfactor (double) 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. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + porosity : [double precision] + is the aquifer porosity. + retfactor : [double precision] + 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. izone : [integer] - * izone (integer) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. """ @@ -61,11 +47,8 @@ class ModflowPrtmip(mfpackage.MFPackage): package_abbr = "prtmip" _package_type = "mip" dfn_file_name = "prt-mip.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name export_array_ascii", @@ -114,13 +97,60 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowPrtmip defines a MIP package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + export_array_ascii : keyword + keyword that specifies input griddata arrays should be written to layered ascii + output files. + porosity : [double precision] + is the aquifer porosity. + retfactor : [double precision] + 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. + izone : [integer] + 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. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "mip", filename, pname, loading_package, **kwargs) - # set up variables self.export_array_ascii = self.build_mfdata( "export_array_ascii", export_array_ascii ) self.porosity = self.build_mfdata("porosity", porosity) self.retfactor = self.build_mfdata("retfactor", retfactor) self.izone = self.build_mfdata("izone", izone) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfprtnam.py b/flopy/mf6/modflow/mfprtnam.py index ca81985966..53c0114271 100644 --- a/flopy/mf6/modflow/mfprtnam.py +++ b/flopy/mf6/modflow/mfprtnam.py @@ -1,67 +1,36 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowPrtnam(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowPrtnam(MFPackage): """ - ModflowPrtnam defines a nam package within a prt6 model. + ModflowPrtnam defines a NAM package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. list : string - * list (string) 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". - print_input : boolean - * print_input (boolean) keyword to indicate that the list of all model - stress package information will be written to the listing file - immediately after it is read. - print_flows : boolean - * print_flows (boolean) 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. - save_flows : boolean - * save_flows (boolean) keyword to indicate that all model package flow - terms will be written to the file specified with "BUDGET FILEOUT" in - Output Control. - packages : [ftype, fname, pname] - * ftype (string) 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. - * fname (string) 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. - * pname (string) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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'. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that all model package flow terms will be written to the + file specified with 'budget fileout' in output control. + packages : list """ @@ -69,11 +38,8 @@ class ModflowPrtnam(mfpackage.MFPackage): package_abbr = "prtnam" _package_type = "nam" dfn_file_name = "prt-nam.dfn" - dfn = [ - [ - "header", - ], + ["header"], ["block options", "name list", "type string", "reader urword", "optional true"], [ "block options", @@ -144,12 +110,52 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowPrtnam defines a NAM package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + list : string + 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'. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + print_flows : keyword + 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. + save_flows : keyword + keyword to indicate that all model package flow terms will be written to the + file specified with 'budget fileout' in output control. + packages : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "nam", filename, pname, loading_package, **kwargs) - # set up variables self.list = self.build_mfdata("list", list) self.print_input = self.build_mfdata("print_input", print_input) self.print_flows = self.build_mfdata("print_flows", print_flows) self.save_flows = self.build_mfdata("save_flows", save_flows) self.packages = self.build_mfdata("packages", packages) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfprtoc.py b/flopy/mf6/modflow/mfprtoc.py index f833823914..1dd25598e0 100644 --- a/flopy/mf6/modflow/mfprtoc.py +++ b/flopy/mf6/modflow/mfprtoc.py @@ -1,118 +1,85 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowPrtoc(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowPrtoc(MFPackage): """ - ModflowPrtoc defines a oc package within a prt6 model. + ModflowPrtoc defines a OC package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - budget_filerecord : [budgetfile] - * budgetfile (string) name of the output file to write budget - information. - budgetcsv_filerecord : [budgetcsvfile] - * budgetcsvfile (string) 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. - track_filerecord : [trackfile] - * trackfile (string) name of the binary output file to write tracking - information. - trackcsv_filerecord : [trackcsvfile] - * trackcsvfile (string) name of the comma-separated value (CSV) file to - write tracking information. - track_release : boolean - * track_release (boolean) keyword to indicate that particle tracking - output is to be written when a particle is released - track_exit : boolean - * track_exit (boolean) keyword to indicate that particle tracking - output is to be written when a particle exits a feature (a model, - cell, or subcell) - track_timestep : boolean - * track_timestep (boolean) keyword to indicate that particle tracking - output is to be written at the end of each time step - track_terminate : boolean - * track_terminate (boolean) keyword to indicate that particle tracking - output is to be written when a particle terminates for any reason - track_weaksink : boolean - * track_weaksink (boolean) 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) - track_usertime : boolean - * track_usertime (boolean) keyword to indicate that particle tracking - output is to be written at user-specified times, provided as double - precision values in the TRACKTIMES block. + budget_filerecord : (budgetfile) + * budgetfile : string + name of the output file to write budget information. + + budgetcsv_filerecord : (budgetcsvfile) + * budgetcsvfile : string + 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. + + track_filerecord : (trackfile) + * trackfile : string + name of the binary output file to write tracking information. + + trackcsv_filerecord : (trackcsvfile) + * trackcsvfile : string + name of the comma-separated value (CSV) file to write tracking information. + + track_release : keyword + keyword to indicate that particle tracking output is to be written when a + particle is released + track_exit : keyword + keyword to indicate that particle tracking output is to be written when a + particle exits a feature (a model, cell, or subcell) + track_timestep : keyword + keyword to indicate that particle tracking output is to be written at the end + of each time step + track_terminate : keyword + keyword to indicate that particle tracking output is to be written when a + particle terminates for any reason + track_weaksink : keyword + 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) + track_usertime : keyword + keyword to indicate that particle tracking output is to be written at user- + specified times, provided as double precision values in the tracktimes block. + track_timesrecord : (track_times, times) + * track_times : keyword + keyword indicating tracking times will follow + * times : [double precision] + times to track, relative to the beginning of the simulation. + + track_timesfilerecord : (timesfile) + * timesfile : string + name of the tracking times file + ntracktimes : integer - * ntracktimes (integer) is the number of user-specified particle - tracking times in the TRACKTIMES block. - tracktimes : time - * time (double) real value that defines the tracking time with respect - to the simulation start time. - saverecord : [rtype, ocsetting] - * rtype (string) type of information to save or print. Can only be - BUDGET. - * ocsetting (keystring) specifies the steps for which the data will be - saved. - all : [keyword] - * all (keyword) keyword to indicate save for all time steps in - period. - first : [keyword] - * first (keyword) 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. - last : [keyword] - * last (keyword) 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. - frequency : [integer] - * frequency (integer) 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. - steps : [integer] - * steps (integer) 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. - printrecord : [rtype, ocsetting] - * rtype (string) type of information to save or print. Can only be - BUDGET. - * ocsetting (keystring) specifies the steps for which the data will be - saved. - all : [keyword] - * all (keyword) keyword to indicate save for all time steps in - period. - first : [keyword] - * first (keyword) 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. - last : [keyword] - * last (keyword) 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. - frequency : [integer] - * frequency (integer) 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. - steps : [integer] - * steps (integer) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + is the number of user-specified particle tracking times in the tracktimes + block. + tracktimes : [list] + saverecord : (save, rtype, ocsetting) + * save : keyword + keyword to indicate that information will be saved this stress period. + * rtype : string + type of information to save or print. Can only be BUDGET. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + + printrecord : (print, rtype, ocsetting) + * print : keyword + keyword to indicate that information will be printed this stress period. + * rtype : string + type of information to save or print. Can only be BUDGET. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + """ @@ -128,17 +95,20 @@ class ModflowPrtoc(mfpackage.MFPackage): trackcsv_filerecord = ListTemplateGenerator( ("prt6", "oc", "options", "trackcsv_filerecord") ) + track_timesrecord = ListTemplateGenerator( + ("prt6", "oc", "options", "track_timesrecord") + ) + track_timesfilerecord = ListTemplateGenerator( + ("prt6", "oc", "options", "track_timesfilerecord") + ) tracktimes = ListTemplateGenerator(("prt6", "oc", "tracktimes", "tracktimes")) saverecord = ListTemplateGenerator(("prt6", "oc", "period", "saverecord")) printrecord = ListTemplateGenerator(("prt6", "oc", "period", "printrecord")) package_abbr = "prtoc" _package_type = "oc" dfn_file_name = "prt-oc.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name budget_filerecord", @@ -311,6 +281,69 @@ class ModflowPrtoc(mfpackage.MFPackage): "reader urword", "optional true", ], + [ + "block options", + "name track_timesrecord", + "type record track_times times", + "shape", + "reader urword", + "tagged true", + "optional true", + "removed 6.6.1", + ], + [ + "block options", + "name track_times", + "type keyword", + "reader urword", + "in_record true", + "tagged true", + "shape", + "removed 6.6.1", + ], + [ + "block options", + "name times", + "type double precision", + "shape (unknown)", + "reader urword", + "in_record true", + "tagged false", + "repeating true", + "removed 6.6.1", + ], + [ + "block options", + "name track_timesfilerecord", + "type record track_timesfile timesfile", + "shape", + "reader urword", + "tagged true", + "optional true", + "removed 6.6.1", + ], + [ + "block options", + "name track_timesfile", + "type keyword", + "reader urword", + "in_record true", + "tagged true", + "shape", + "removed 6.6.1", + ], + [ + "block options", + "name timesfile", + "type string", + "preserve_case true", + "shape", + "in_record true", + "reader urword", + "tagged false", + "optional false", + "removed 6.6.1", + ], [ "block dimensions", "name ntracktimes", @@ -461,6 +494,8 @@ def __init__( track_terminate=None, track_weaksink=None, track_usertime=None, + track_timesrecord=None, + track_timesfilerecord=None, ntracktimes=None, tracktimes=None, saverecord=None, @@ -469,9 +504,80 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowPrtoc defines a OC package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + budget_filerecord : record + budgetcsv_filerecord : record + track_filerecord : record + trackcsv_filerecord : record + track_release : keyword + keyword to indicate that particle tracking output is to be written when a + particle is released + track_exit : keyword + keyword to indicate that particle tracking output is to be written when a + particle exits a feature (a model, cell, or subcell) + track_timestep : keyword + keyword to indicate that particle tracking output is to be written at the end + of each time step + track_terminate : keyword + keyword to indicate that particle tracking output is to be written when a + particle terminates for any reason + track_weaksink : keyword + 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) + track_usertime : keyword + keyword to indicate that particle tracking output is to be written at user- + specified times, provided as double precision values in the tracktimes block. + track_timesrecord : (track_times, times) + * track_times : keyword + keyword indicating tracking times will follow + * times : [double precision] + times to track, relative to the beginning of the simulation. + + track_timesfilerecord : record + ntracktimes : integer + is the number of user-specified particle tracking times in the tracktimes + block. + tracktimes : [list] + saverecord : (save, rtype, ocsetting) + * save : keyword + keyword to indicate that information will be saved this stress period. + * rtype : string + type of information to save or print. Can only be BUDGET. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + + printrecord : (print, rtype, ocsetting) + * print : keyword + keyword to indicate that information will be printed this stress period. + * rtype : string + type of information to save or print. Can only be BUDGET. + * ocsetting : keystring all first last frequency steps + specifies the steps for which the data will be saved. + + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "oc", filename, pname, loading_package, **kwargs) - # set up variables self.budget_filerecord = self.build_mfdata( "budget_filerecord", budget_filerecord ) @@ -488,8 +594,15 @@ def __init__( self.track_terminate = self.build_mfdata("track_terminate", track_terminate) self.track_weaksink = self.build_mfdata("track_weaksink", track_weaksink) self.track_usertime = self.build_mfdata("track_usertime", track_usertime) + self.track_timesrecord = self.build_mfdata( + "track_timesrecord", track_timesrecord + ) + self.track_timesfilerecord = self.build_mfdata( + "track_timesfilerecord", track_timesfilerecord + ) self.ntracktimes = self.build_mfdata("ntracktimes", ntracktimes) self.tracktimes = self.build_mfdata("tracktimes", tracktimes) self.saverecord = self.build_mfdata("saverecord", saverecord) self.printrecord = self.build_mfdata("printrecord", printrecord) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfprtprp.py b/flopy/mf6/modflow/mfprtprp.py index 2ecaee77fd..5f3044e4c3 100644 --- a/flopy/mf6/modflow/mfprtprp.py +++ b/flopy/mf6/modflow/mfprtprp.py @@ -1,226 +1,133 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowPrtprp(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowPrtprp(MFPackage): """ - ModflowPrtprp defines a prp package within a prt6 model. + ModflowPrtprp defines a PRP package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - boundnames : boolean - * boundnames (boolean) keyword to indicate that boundary names may be - provided with the list of particle release points. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of all model - stress package information will be written to the listing file - immediately after it is read. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + particle release points. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. dev_exit_solve_method : integer - * dev_exit_solve_method (integer) 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. - exit_solve_tolerance : double - * exit_solve_tolerance (double) the convergence tolerance for iterative - solution of particle exit location and time in the generalized - Pollock's method. A value of 0.00001 works well for many problems, - but the value that strikes the best balance between accuracy and - runtime is problem-dependent. - local_z : boolean - * local_z (boolean) 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 top of the cell. If the cell is partially - saturated at release time, the 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. - extend_tracking : boolean - * extend_tracking (boolean) 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. - track_filerecord : [trackfile] - * trackfile (string) name of the binary output file to write tracking - information. - trackcsv_filerecord : [trackcsvfile] - * trackcsvfile (string) name of the comma-separated value (CSV) file to - write tracking information. - stoptime : double - * stoptime (double) 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. - stoptraveltime : double - * stoptraveltime (double) 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. - stop_at_weak_sink : boolean - * stop_at_weak_sink (boolean) 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. + 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. + exit_solve_tolerance : double precision + the convergence tolerance for iterative solution of particle exit location and + time in the generalized pollock's method. a value of 0.00001 works well for + many problems, but the value that strikes the best balance between accuracy and + runtime is problem-dependent. + local_z : keyword + 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 top of the cell. + if the cell is partially saturated at release time, the 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. + extend_tracking : keyword + 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. + track_filerecord : (trackfile) + * trackfile : string + name of the binary output file to write tracking information. + + trackcsv_filerecord : (trackcsvfile) + * trackcsvfile : string + name of the comma-separated value (CSV) file to write tracking information. + + stoptime : double precision + 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. + stoptraveltime : double precision + 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. + stop_at_weak_sink : keyword + 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. istopzone : integer - * istopzone (integer) 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. - drape : boolean - * drape (boolean) 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. + 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. + drape : keyword + 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. + release_timesrecord : (release_times, times) + * release_times : keyword + keyword indicating release times will follow + * times : [double precision] + times to release, relative to the beginning of the simulation. RELEASE_TIMES + and RELEASE_TIMESFILE are mutually exclusive. + + release_timesfilerecord : (timesfile) + * timesfile : string + name of the release times file. RELEASE_TIMES and RELEASE_TIMESFILE are + mutually exclusive. + dry_tracking_method : string - * dry_tracking_method (string) 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. - dev_forceternary : boolean - * dev_forceternary (boolean) force use of the ternary tracking method - regardless of cell type in DISV grids. - release_time_tolerance : double - * release_time_tolerance (double) 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 :math:`\\epsilon \\times 10^{11}`, where - :math:`\\epsilon` is machine precision. - release_time_frequency : double - * release_time_frequency (double) 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. + 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. + dev_forceternary : keyword + force use of the ternary tracking method regardless of cell type in disv grids. + release_time_tolerance : double precision + 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 :math:`epsilon times 10^{11}`, where + :math:`epsilon` is machine precision. + release_time_frequency : double precision + 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. nreleasepts : integer - * nreleasepts (integer) is the number of particle release points. + is the number of particle release points. nreleasetimes : integer - * nreleasetimes (integer) 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. - packagedata : [irptno, cellid, xrpt, yrpt, zrpt, boundname] - * irptno (integer) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * xrpt (double) 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. - * yrpt (double) 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. - * zrpt (double) 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. - * boundname (string) 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. - releasetimes : time - * time (double) real value that defines the release time with respect - to the simulation start time. - perioddata : releasesetting - * releasesetting (keystring) 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 :math:`\\epsilon - \\times 10^{11}` by default, where :math:`\\epsilon` is machine - precision. 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. - all : [keyword] - * all (keyword) keyword to indicate release at the start of all - time steps in the period. - first : [keyword] - * first (keyword) 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. - last : [keyword] - * last (keyword) 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. - frequency : [integer] - * frequency (integer) release at the specified time step - frequency. This keyword may be used in conjunction with other - RELEASESETTING options. - steps : [integer] - * steps (integer) release at the start of each step specified - in STEPS. This option may be used in conjunction with other - RELEASESETTING options. - fraction : [double] - * fraction (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + packagedata : [list] + releasetimes : [list] + perioddata : list """ @@ -230,6 +137,12 @@ class ModflowPrtprp(mfpackage.MFPackage): trackcsv_filerecord = ListTemplateGenerator( ("prt6", "prp", "options", "trackcsv_filerecord") ) + release_timesrecord = ListTemplateGenerator( + ("prt6", "prp", "options", "release_timesrecord") + ) + release_timesfilerecord = ListTemplateGenerator( + ("prt6", "prp", "options", "release_timesfilerecord") + ) packagedata = ListTemplateGenerator(("prt6", "prp", "packagedata", "packagedata")) releasetimes = ListTemplateGenerator( ("prt6", "prp", "releasetimes", "releasetimes") @@ -238,12 +151,8 @@ class ModflowPrtprp(mfpackage.MFPackage): package_abbr = "prtprp" _package_type = "prp" dfn_file_name = "prt-prp.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name boundnames", @@ -272,7 +181,7 @@ class ModflowPrtprp(mfpackage.MFPackage): "type double precision", "reader urword", "optional true", - "default_value 1e-5", + "default 1e-5", ], [ "block options", @@ -393,6 +302,69 @@ class ModflowPrtprp(mfpackage.MFPackage): "reader urword", "optional true", ], + [ + "block options", + "name release_timesrecord", + "type record release_times times", + "shape", + "reader urword", + "tagged true", + "optional true", + "removed 6.6.1", + ], + [ + "block options", + "name release_times", + "type keyword", + "reader urword", + "in_record true", + "tagged true", + "shape", + "removed 6.6.1", + ], + [ + "block options", + "name times", + "type double precision", + "shape (unknown)", + "reader urword", + "in_record true", + "tagged false", + "repeating true", + "removed 6.6.1", + ], + [ + "block options", + "name release_timesfilerecord", + "type record release_timesfile timesfile", + "shape", + "reader urword", + "tagged true", + "optional true", + "removed 6.6.1", + ], + [ + "block options", + "name release_timesfile", + "type keyword", + "reader urword", + "in_record true", + "tagged true", + "shape", + "removed 6.6.1", + ], + [ + "block options", + "name timesfile", + "type string", + "preserve_case true", + "shape", + "in_record true", + "reader urword", + "tagged false", + "optional false", + "removed 6.6.1", + ], [ "block options", "name dry_tracking_method", @@ -606,7 +578,7 @@ def __init__( boundnames=None, print_input=None, dev_exit_solve_method=None, - exit_solve_tolerance=1e-5, + exit_solve_tolerance=1e-05, local_z=None, extend_tracking=None, track_filerecord=None, @@ -616,6 +588,8 @@ def __init__( stop_at_weak_sink=None, istopzone=None, drape=None, + release_timesrecord=None, + release_timesfilerecord=None, dry_tracking_method=None, dev_forceternary=None, release_time_tolerance=None, @@ -629,9 +603,135 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowPrtprp defines a PRP package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + boundnames : keyword + keyword to indicate that boundary names may be provided with the list of + particle release points. + print_input : keyword + keyword to indicate that the list of all model stress package information will + be written to the listing file immediately after it is read. + dev_exit_solve_method : integer + 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. + exit_solve_tolerance : double precision + the convergence tolerance for iterative solution of particle exit location and + time in the generalized pollock's method. a value of 0.00001 works well for + many problems, but the value that strikes the best balance between accuracy and + runtime is problem-dependent. + local_z : keyword + 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 top of the cell. + if the cell is partially saturated at release time, the 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. + extend_tracking : keyword + 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. + track_filerecord : record + trackcsv_filerecord : record + stoptime : double precision + 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. + stoptraveltime : double precision + 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. + stop_at_weak_sink : keyword + 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. + istopzone : integer + 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. + drape : keyword + 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. + release_timesrecord : (release_times, times) + * release_times : keyword + keyword indicating release times will follow + * times : [double precision] + times to release, relative to the beginning of the simulation. RELEASE_TIMES + and RELEASE_TIMESFILE are mutually exclusive. + + release_timesfilerecord : record + dry_tracking_method : string + 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. + dev_forceternary : keyword + force use of the ternary tracking method regardless of cell type in disv grids. + release_time_tolerance : double precision + 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 :math:`epsilon times 10^{11}`, where + :math:`epsilon` is machine precision. + release_time_frequency : double precision + 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. + nreleasepts : integer + is the number of particle release points. + nreleasetimes : integer + 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. + packagedata : [list] + releasetimes : [list] + perioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "prp", filename, pname, loading_package, **kwargs) - # set up variables self.boundnames = self.build_mfdata("boundnames", boundnames) self.print_input = self.build_mfdata("print_input", print_input) self.dev_exit_solve_method = self.build_mfdata( @@ -653,6 +753,12 @@ def __init__( ) self.istopzone = self.build_mfdata("istopzone", istopzone) self.drape = self.build_mfdata("drape", drape) + self.release_timesrecord = self.build_mfdata( + "release_timesrecord", release_timesrecord + ) + self.release_timesfilerecord = self.build_mfdata( + "release_timesfilerecord", release_timesfilerecord + ) self.dry_tracking_method = self.build_mfdata( "dry_tracking_method", dry_tracking_method ) @@ -668,4 +774,5 @@ def __init__( self.packagedata = self.build_mfdata("packagedata", packagedata) self.releasetimes = self.build_mfdata("releasetimes", releasetimes) self.perioddata = self.build_mfdata("perioddata", perioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfpts.py b/flopy/mf6/modflow/mfpts.py index b472349ec3..8beed5da32 100644 --- a/flopy/mf6/modflow/mfpts.py +++ b/flopy/mf6/modflow/mfpts.py @@ -1,113 +1,110 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowPts(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowPts(MFPackage): """ - ModflowPts defines a pts package. + ModflowPts defines a PTS package. Parameters ---------- - simulation : MFSimulation - Simulation that this package is a part of. Package is automatically - added to simulation when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. print_option : string - * print_option (string) 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. + 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. complexity : string - * complexity (string) 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. - csv_output_filerecord : [csvfile] - * csvfile (string) 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. - csv_outer_output_filerecord : [outer_csvfile] - * outer_csvfile (string) 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. - csv_inner_output_filerecord : [inner_csvfile] - * inner_csvfile (string) 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. - no_ptcrecord : [no_ptc_option] - * no_ptc_option (string) 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. - ats_outer_maximum_fraction : double - * ats_outer_maximum_fraction (double) 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. + 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. + csv_output_filerecord : (csvfile) + * csvfile : string + 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. + + csv_outer_output_filerecord : (outer_csvfile) + * outer_csvfile : string + 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. + + csv_inner_output_filerecord : (inner_csvfile) + * inner_csvfile : string + 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. + + no_ptcrecord : (no_ptc, no_ptc_option) + * no_ptc : keyword + 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. + * no_ptc_option : string + 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. + + ats_outer_maximum_fraction : double precision + 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. outer_maximum : integer - * outer_maximum (integer) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. """ @@ -124,11 +121,8 @@ class ModflowPts(mfpackage.MFPackage): package_abbr = "pts" _package_type = "pts" dfn_file_name = "sln-pts.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name print_option", @@ -303,9 +297,100 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowPts defines a PTS package. + + Parameters + ---------- + simulation + Simulation that this package is a part of. Package is automatically + added to simulation when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + print_option : string + 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. + complexity : string + 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. + csv_output_filerecord : record + csv_outer_output_filerecord : record + csv_inner_output_filerecord : record + no_ptcrecord : (no_ptc, no_ptc_option) + * no_ptc : keyword + 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. + * no_ptc_option : string + 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. + + ats_outer_maximum_fraction : double precision + 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. + outer_maximum : integer + 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. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(simulation, "pts", filename, pname, loading_package, **kwargs) - # set up variables self.print_option = self.build_mfdata("print_option", print_option) self.complexity = self.build_mfdata("complexity", complexity) self.csv_output_filerecord = self.build_mfdata( @@ -322,4 +407,5 @@ def __init__( "ats_outer_maximum_fraction", ats_outer_maximum_fraction ) self.outer_maximum = self.build_mfdata("outer_maximum", outer_maximum) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfsimulation.py b/flopy/mf6/modflow/mfsimulation.py index 192a872e7a..9ce78e9082 100644 --- a/flopy/mf6/modflow/mfsimulation.py +++ b/flopy/mf6/modflow/mfsimulation.py @@ -1,85 +1,60 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -import os +# autogenerated file, do not modify + +from os import PathLike, curdir from typing import Union -from .. import mfsimbase +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfsimbase import MFSimulationBase -class MFSimulation(mfsimbase.MFSimulationBase): +class MFSimulation(MFSimulationBase): """ - MFSimulation is used to load, build, and/or save a MODFLOW 6 simulation. - A MFSimulation object must be created before creating any of the MODFLOW 6 - model objects. + MFSimulation is used to load, build, and/or save a MODFLOW 6 simulation. A MFSimulation object must be created before creating any of the MODFLOW 6 model objects. Parameters ---------- - sim_name : str - Name of the simulation - continue_ : boolean - * continue (boolean) keyword flag to indicate that the simulation - should continue even if one or more solutions do not converge. - nocheck : boolean - * nocheck (boolean) keyword flag to indicate that the model input check - routines should not be called prior to each time step. Checks are - performed by default. + continue_ : keyword + keyword flag to indicate that the simulation should continue even if one or + more solutions do not converge. + nocheck : keyword + keyword flag to indicate that the model input check routines should not be + called prior to each time step. checks are performed by default. memory_print_option : string - * memory_print_option (string) 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. + 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. profile_option : string - * profile_option (string) 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. + 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. maxerrors : integer - * maxerrors (integer) maximum number of errors that will be stored and - printed. - print_input : boolean - * print_input (boolean) 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. - hpc_data : {varname:data} or hpc_data data - * Contains data for the hpc package. Data can be stored in a dictionary - containing data for the hpc package with variable names as keys and - package data as values. Data just for the hpc_data variable is also - acceptable. See hpc package documentation for more information. + maximum number of errors that will be stored and printed. + print_input : keyword + 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. + hpc_data : record hpc6 filein hpc6_filename + Contains data for the hpc package. Data can be passed as a dictionary to the + hpc package with variable names as keys and package data as values. Data for + the hpc_data variable is also acceptable. See hpc package documentation for + more information. tdis6 : string - * tdis6 (string) is the name of the Temporal Discretization (TDIS) - Input File. - models : [mtype, mfname, mname] - * mtype (string) is the type of model to add to simulation. - * mfname (string) is the file name of the model name file. - * mname (string) 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. - exchanges : [exgtype, exgfile, exgmnamea, exgmnameb] - * exgtype (string) is the exchange type. - * exgfile (string) is the input file for the exchange. - * exgmnamea (string) is the name of the first model that is part of - this exchange. - * exgmnameb (string) is the name of the second model that is part of - this exchange. + is the name of the temporal discretization (tdis) input file. + models : list + is the list of model types, model name files, and model names. + exchanges : list + is the list of exchange types, exchange files, and model names. mxiter : integer - * mxiter (integer) 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. - solutiongroup : [slntype, slnfname, slnmnames] - * slntype (string) is the type of solution. The Integrated Model - Solution (IMS6) and Explicit Model Solution (EMS6) are the only - supported options in this version. - * slnfname (string) name of file containing solution input. - * slnmnames (string) 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. + 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. + solutiongroup : list + is the list of solution types and models in the solution. + Methods ------- @@ -93,22 +68,87 @@ class MFSimulation(mfsimbase.MFSimulationBase): def __init__( self, - sim_name="sim", - version="mf6", - exe_name: Union[str, os.PathLike] = "mf6", - sim_ws: Union[str, os.PathLike] = os.curdir, - verbosity_level=1, - write_headers=True, - use_pandas=True, - lazy_io=False, + sim_name: str = "sim", + version: str = "mf6", + exe_name: Union[str, PathLike] = "mf6", + sim_ws: Union[str, PathLike] = curdir, + verbosity_level: int = 1, + write_headers: bool = True, + use_pandas: bool = True, + lazy_io: bool = False, continue_=None, nocheck=None, memory_print_option=None, profile_option=None, maxerrors=None, print_input=None, - hpc_data_data=None, + hpc_data=None, ): + """ + MFSimulation is used to load, build, and/or save a MODFLOW 6 simulation. A MFSimulation object must be created before creating any of the MODFLOW 6 model objects. + + Parameters + ---------- + sim_name + The name of the simulation + version + The simulation version + exe_name + The executable name + sim_ws + The simulation workspace + verbosity_level + The verbosity level + write_headers + Whether to write + use_pandas + Whether to use pandas + lazy_io + Whether to use lazy IO + continue_ : keyword + keyword flag to indicate that the simulation should continue even if one or + more solutions do not converge. + nocheck : keyword + keyword flag to indicate that the model input check routines should not be + called prior to each time step. checks are performed by default. + memory_print_option : string + 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. + profile_option : string + 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. + maxerrors : integer + maximum number of errors that will be stored and printed. + print_input : keyword + 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. + hpc_data : record hpc6 filein hpc6_filename + Contains data for the hpc package. Data can be passed as a dictionary to the + hpc package with variable names as keys and package data as values. Data for + the hpc_data variable is also acceptable. See hpc package documentation for + more information. + tdis6 : string + is the name of the temporal discretization (tdis) input file. + models : list + is the list of model types, model name files, and model names. + exchanges : list + is the list of exchange types, exchange files, and model names. + mxiter : integer + 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. + solutiongroup : list + is the list of solution types and models in the solution. + + """ + super().__init__( sim_name=sim_name, version=version, @@ -121,27 +161,26 @@ def __init__( ) self.name_file.continue_.set_data(continue_) - self.name_file.nocheck.set_data(nocheck) - self.name_file.memory_print_option.set_data(memory_print_option) - self.name_file.profile_option.set_data(profile_option) - self.name_file.maxerrors.set_data(maxerrors) - self.name_file.print_input.set_data(print_input) - self.continue_ = self.name_file.continue_ + self.name_file.nocheck.set_data(nocheck) self.nocheck = self.name_file.nocheck + self.name_file.memory_print_option.set_data(memory_print_option) self.memory_print_option = self.name_file.memory_print_option + self.name_file.profile_option.set_data(profile_option) self.profile_option = self.name_file.profile_option + self.name_file.maxerrors.set_data(maxerrors) self.maxerrors = self.name_file.maxerrors + self.name_file.print_input.set_data(print_input) self.print_input = self.name_file.print_input - self.hpc_data_data = self._create_package("hpc_data", hpc_data_data) + self.hpc_data = self._create_package("hpc", hpc_data) @classmethod def load( cls, sim_name="modflowsim", version="mf6", - exe_name: Union[str, os.PathLike] = "mf6", - sim_ws: Union[str, os.PathLike] = os.curdir, + exe_name: Union[str, PathLike] = "mf6", + sim_ws: Union[str, PathLike] = curdir, strict=True, verbosity_level=1, load_only=None, @@ -150,7 +189,7 @@ def load( lazy_io=False, use_pandas=True, ): - return mfsimbase.MFSimulationBase.load( + return MFSimulationBase.load( cls, sim_name, version, diff --git a/flopy/mf6/modflow/mftdis.py b/flopy/mf6/modflow/mftdis.py index 4e26940eef..3c10c9f809 100644 --- a/flopy/mf6/modflow/mftdis.py +++ b/flopy/mf6/modflow/mftdis.py @@ -1,57 +1,36 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowTdis(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowTdis(MFPackage): """ - ModflowTdis defines a tdis package. + ModflowTdis defines a TDIS package. Parameters ---------- - simulation : MFSimulation - Simulation that this package is a part of. Package is automatically - added to simulation when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. time_units : string - * time_units (string) 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". + 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'. start_date_time : string - * start_date_time (string) 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. - ats_perioddata : {varname:data} or perioddata data - * Contains data for the ats package. Data can be stored in a dictionary - containing data for the ats package with variable names as keys and - package data as values. Data just for the ats_perioddata variable is - also acceptable. See ats package documentation for more information. + 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. + ats_perioddata : record ats6 filein ats6_filename + Contains data for the ats package. Data can be passed as a dictionary to the + ats package with variable names as keys and package data as values. Data for + the ats_perioddata variable is also acceptable. See ats package documentation + for more information. nper : integer - * nper (integer) is the number of stress periods for the simulation. - perioddata : [perlen, nstp, tsmult] - * perlen (double) is the length of a stress period. - * nstp (integer) is the number of time steps in a stress period. - * tsmult (double) 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, :math:`\\Delta t_1`, is related to PERLEN, NSTP, and - TSMULT by the relation :math:`\\Delta t_1= perlen \\frac{tsmult - - 1}{tsmult^{nstp}-1}`. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + is the number of stress periods for the simulation. + perioddata : list """ @@ -60,11 +39,8 @@ class ModflowTdis(mfpackage.MFPackage): package_abbr = "tdis" _package_type = "tdis" dfn_file_name = "sim-tdis.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name time_units", @@ -88,8 +64,8 @@ class ModflowTdis(mfpackage.MFPackage): "tagged true", "optional true", "construct_package ats", - "construct_data perioddata", - "parameter_name ats_perioddata", + "construct_data ats_perioddata", + "parameter_name perioddata", ], [ "block options", @@ -127,7 +103,7 @@ class ModflowTdis(mfpackage.MFPackage): "type integer", "reader urword", "optional false", - "default_value 1", + "default 1", ], [ "block perioddata", @@ -135,7 +111,7 @@ class ModflowTdis(mfpackage.MFPackage): "type recarray perlen nstp tsmult", "reader urword", "optional false", - "default_value ((1.0, 1, 1.0),)", + "default ((1.0, 1, 1.0),)", ], [ "block perioddata", @@ -174,14 +150,53 @@ def __init__( start_date_time=None, ats_perioddata=None, nper=1, - perioddata=((1.0, 1, 1.0),), + perioddata=[[1.0, 1, 1.0]], filename=None, pname=None, **kwargs, ): + """ + ModflowTdis defines a TDIS package. + + Parameters + ---------- + simulation + Simulation that this package is a part of. Package is automatically + added to simulation when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + time_units : string + 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'. + start_date_time : string + 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. + ats_perioddata : record ats6 filein ats6_filename + Contains data for the ats package. Data can be passed as a dictionary to the + ats package with variable names as keys and package data as values. Data for + the ats_perioddata variable is also acceptable. See ats package documentation + for more information. + nper : integer + is the number of stress periods for the simulation. + perioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(simulation, "tdis", filename, pname, loading_package, **kwargs) - # set up variables self.time_units = self.build_mfdata("time_units", time_units) self.start_date_time = self.build_mfdata("start_date_time", start_date_time) self._ats_filerecord = self.build_mfdata("ats_filerecord", None) @@ -190,4 +205,5 @@ def __init__( ) self.nper = self.build_mfdata("nper", nper) self.perioddata = self.build_mfdata("perioddata", perioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfutlats.py b/flopy/mf6/modflow/mfutlats.py index 8aec150d0f..379b8f63b8 100644 --- a/flopy/mf6/modflow/mfutlats.py +++ b/flopy/mf6/modflow/mfutlats.py @@ -1,73 +1,22 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowUtlats(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowUtlats(MFPackage): """ - ModflowUtlats defines a ats package within a utl model. + ModflowUtlats defines a ATS package. Parameters ---------- - parent_package : MFPackage - Parent_package that this package is a part of. Package is automatically - added to parent_package when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. maxats : integer - * maxats (integer) is the number of records in the subsequent - perioddata block that will be used for adaptive time stepping. - perioddata : [iperats, dt0, dtmin, dtmax, dtadj, dtfailadj] - * iperats (integer) is the period number to designate for adaptive time - stepping. 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. This argument is an index variable, - which means that it should be treated as zero-based when working with - FloPy and Python. Flopy will automatically subtract one when loading - index variables and add one when writing index variables. - * dt0 (double) 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. - * dtmin (double) 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. - * dtmax (double) is the maximum time step length for this period. This - value must be greater than dtmin. - * dtadj (double) 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. - * dtfailadj (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + is the number of records in the subsequent perioddata block that will be used + for adaptive time stepping. + perioddata : list """ @@ -75,18 +24,15 @@ class ModflowUtlats(mfpackage.MFPackage): package_abbr = "utlats" _package_type = "ats" dfn_file_name = "utl-ats.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block dimensions", "name maxats", "type integer", "reader urword", "optional false", - "default_value 1", + "default 1", ], [ "block perioddata", @@ -162,17 +108,43 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowUtlats defines a ATS package. + + Parameters + ---------- + parent_package + Parent_package that this package is a part of. Package is automatically + added to parent_package when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + maxats : integer + is the number of records in the subsequent perioddata block that will be used + for adaptive time stepping. + perioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__( parent_package, "ats", filename, pname, loading_package, **kwargs ) - # set up variables self.maxats = self.build_mfdata("maxats", maxats) self.perioddata = self.build_mfdata("perioddata", perioddata) + self._init_complete = True -class UtlatsPackages(mfpackage.MFChildPackages): +class UtlatsPackages(MFChildPackages): """ UtlatsPackages is a container class for the ModflowUtlats class. @@ -185,11 +157,18 @@ class UtlatsPackages(mfpackage.MFChildPackages): append_package Adds a new ModflowUtlats package to the container. See ModflowUtlats init documentation for definition of parameters. + """ package_abbr = "utlatspackages" - def initialize(self, maxats=1, perioddata=None, filename=None, pname=None): + def initialize( + self, + maxats=1, + perioddata=None, + filename=None, + pname=None, + ): new_package = ModflowUtlats( self._cpparent, maxats=maxats, @@ -200,7 +179,13 @@ def initialize(self, maxats=1, perioddata=None, filename=None, pname=None): ) self.init_package(new_package, filename) - def append_package(self, maxats=1, perioddata=None, filename=None, pname=None): + def append_package( + self, + maxats=1, + perioddata=None, + filename=None, + pname=None, + ): new_package = ModflowUtlats( self._cpparent, maxats=maxats, diff --git a/flopy/mf6/modflow/mfutlhpc.py b/flopy/mf6/modflow/mfutlhpc.py index 48b7dd9200..c2562922ed 100644 --- a/flopy/mf6/modflow/mfutlhpc.py +++ b/flopy/mf6/modflow/mfutlhpc.py @@ -1,40 +1,25 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowUtlhpc(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowUtlhpc(MFPackage): """ - ModflowUtlhpc defines a hpc package within a utl model. + ModflowUtlhpc defines a HPC package. Parameters ---------- - parent_package : MFSimulation - Parent_package that this package is a part of. Package is automatically - added to parent_package when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - print_table : boolean - * print_table (boolean) keyword to indicate that the partition table - will be printed to the listing file. - dev_log_mpi : boolean - * dev_log_mpi (boolean) keyword to enable (extremely verbose) logging - of mpi traffic to file. - partitions : [mname, mrank] - * mname (string) is the unique model name. - * mrank (integer) is the zero-based partition number (also: MPI rank or - processor id) to which the model will be assigned. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + print_table : keyword + keyword to indicate that the partition table will be printed to the listing + file. + dev_log_mpi : keyword + keyword to enable (extremely verbose) logging of mpi traffic to file. + partitions : list + is the list of zero-based partition numbers. """ @@ -42,11 +27,8 @@ class ModflowUtlhpc(mfpackage.MFPackage): package_abbr = "utlhpc" _package_type = "hpc" dfn_file_name = "utl-hpc.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name print_table", @@ -97,12 +79,41 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowUtlhpc defines a HPC package. + + Parameters + ---------- + parent_package + Parent_package that this package is a part of. Package is automatically + added to parent_package when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + print_table : keyword + keyword to indicate that the partition table will be printed to the listing + file. + dev_log_mpi : keyword + keyword to enable (extremely verbose) logging of mpi traffic to file. + partitions : list + is the list of zero-based partition numbers. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__( parent_package, "hpc", filename, pname, loading_package, **kwargs ) - # set up variables self.print_table = self.build_mfdata("print_table", print_table) self.dev_log_mpi = self.build_mfdata("dev_log_mpi", dev_log_mpi) self.partitions = self.build_mfdata("partitions", partitions) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfutllaktab.py b/flopy/mf6/modflow/mfutllaktab.py index c2b4cdf85e..e37a523422 100644 --- a/flopy/mf6/modflow/mfutllaktab.py +++ b/flopy/mf6/modflow/mfutllaktab.py @@ -1,49 +1,27 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowUtllaktab(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowUtllaktab(MFPackage): """ - ModflowUtllaktab defines a laktab package within a utl model. + ModflowUtllaktab defines a LAKTAB package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. nrow : integer - * nrow (integer) integer value specifying the number of rows in the - lake table. There must be NROW rows of data in the TABLE block. + integer value specifying the number of rows in the lake table. there must be + nrow rows of data in the table block. ncol : integer - * ncol (integer) 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. - table : [stage, volume, sarea, barea] - * stage (double) real value that defines the stage corresponding to the - remaining data on the line. - * volume (double) real value that defines the lake volume corresponding - to the stage specified on the line. - * sarea (double) real value that defines the lake surface area - corresponding to the stage specified on the line. - * barea (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + table : [list] """ @@ -51,12 +29,8 @@ class ModflowUtllaktab(mfpackage.MFPackage): package_abbr = "utllaktab" _package_type = "laktab" dfn_file_name = "utl-laktab.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block dimensions", "name nrow", @@ -128,10 +102,41 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowUtllaktab defines a LAKTAB package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + nrow : integer + integer value specifying the number of rows in the lake table. there must be + nrow rows of data in the table block. + ncol : integer + 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. + table : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "laktab", filename, pname, loading_package, **kwargs) - # set up variables self.nrow = self.build_mfdata("nrow", nrow) self.ncol = self.build_mfdata("ncol", ncol) self.table = self.build_mfdata("table", table) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfutlncf.py b/flopy/mf6/modflow/mfutlncf.py index ff9c64d2ef..230cd9f1d0 100644 --- a/flopy/mf6/modflow/mfutlncf.py +++ b/flopy/mf6/modflow/mfutlncf.py @@ -1,94 +1,73 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowUtlncf(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowUtlncf(MFPackage): """ - ModflowUtlncf defines a ncf package within a utl model. + ModflowUtlncf defines a NCF package. Parameters ---------- - parent_package : MFPackage - Parent_package that this package is a part of. Package is automatically - added to parent_package when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. wkt : [string] - * wkt (string) is the coordinate reference system (CRS) well-known text - (WKT) string. + is the coordinate reference system (crs) well-known text (wkt) string. ignored + if latitude and longitude griddata arrays have been provided for + netcdf_structured export type. deflate : integer - * deflate (integer) is the variable deflate level (0=min, 9=max) in the - netcdf file. Defining this parameter activates per-variable - compression at the level specified. - shuffle : boolean - * shuffle (boolean) 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. + is the variable deflate level (0=min, 9=max) in the netcdf file. defining this + parameter activates per-variable compression at the level specified. + shuffle : keyword + 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. chunk_time : integer - * chunk_time (integer) is the keyword used to provide a data chunk size - for the time dimension in a NETCDF_MESH2D or NETCDF_STRUCTURED output - file. Must be used in combination with the the chunk_face parameter - (NETCDF_MESH2D) or the chunk_z, chunk_y, and chunk_x parameter set - (NETCDF_STRUCTURED) to have an effect. + is the keyword used to provide a data chunk size for the time dimension in a + netcdf_mesh2d or netcdf_structured output file. must be used in combination + with the the chunk_face parameter (netcdf_mesh2d) or the chunk_z, chunk_y, and + chunk_x parameter set (netcdf_structured) to have an effect. chunk_face : integer - * chunk_face (integer) is the keyword used to provide a data chunk size - for the face dimension in a NETCDF_MESH2D output file. Must be used - in combination with the the chunk_time parameter to have an effect. + is the keyword used to provide a data chunk size for the face dimension in a + netcdf_mesh2d output file. must be used in combination with the the chunk_time + parameter to have an effect. chunk_z : integer - * chunk_z (integer) is the keyword used to provide a data chunk size - for the z dimension in a NETCDF_STRUCTURED output file. Must be used - in combination with the the chunk_time, chunk_x and chunk_y parameter - set to have an effect. + is the keyword used to provide a data chunk size for the z dimension in a + netcdf_structured output file. must be used in combination with the the + chunk_time, chunk_x and chunk_y parameter set to have an effect. chunk_y : integer - * chunk_y (integer) is the keyword used to provide a data chunk size - for the y dimension in a NETCDF_STRUCTURED output file. Must be used - in combination with the the chunk_time, chunk_x and chunk_z parameter - set to have an effect. + is the keyword used to provide a data chunk size for the y dimension in a + netcdf_structured output file. must be used in combination with the the + chunk_time, chunk_x and chunk_z parameter set to have an effect. chunk_x : integer - * chunk_x (integer) is the keyword used to provide a data chunk size - for the x dimension in a NETCDF_STRUCTURED output file. Must be used - in combination with the the chunk_time, chunk_y and chunk_z parameter - set to have an effect. - modflow6_attr_off : boolean - * modflow6_attr_off (boolean) 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. + is the keyword used to provide a data chunk size for the x dimension in a + netcdf_structured output file. must be used in combination with the the + chunk_time, chunk_y and chunk_z parameter set to have an effect. + modflow6_attr_off : keyword + 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. ncpl : integer - * ncpl (integer) is the number of cells in a projected plane layer. - latitude : [double] - * latitude (double) cell center latitude. - longitude : [double] - * longitude (double) cell center longitude. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + is the number of cells in a projected plane layer. + latitude : [double precision] + cell center latitude. only supported for netcdf_structured export type. + longitude : [double precision] + cell center longitude. only supported for netcdf_structured export type. """ - wkt = ListTemplateGenerator(("ncf", "options", "wkt")) + wkt = ArrayTemplateGenerator(("ncf", "options", "wkt")) latitude = ArrayTemplateGenerator(("ncf", "griddata", "latitude")) longitude = ArrayTemplateGenerator(("ncf", "griddata", "longitude")) package_abbr = "utlncf" _package_type = "ncf" dfn_file_name = "utl-ncf.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name wkt", @@ -199,11 +178,76 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowUtlncf defines a NCF package. + + Parameters + ---------- + parent_package + Parent_package that this package is a part of. Package is automatically + added to parent_package when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + wkt : [string] + is the coordinate reference system (crs) well-known text (wkt) string. ignored + if latitude and longitude griddata arrays have been provided for + netcdf_structured export type. + deflate : integer + is the variable deflate level (0=min, 9=max) in the netcdf file. defining this + parameter activates per-variable compression at the level specified. + shuffle : keyword + 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. + chunk_time : integer + is the keyword used to provide a data chunk size for the time dimension in a + netcdf_mesh2d or netcdf_structured output file. must be used in combination + with the the chunk_face parameter (netcdf_mesh2d) or the chunk_z, chunk_y, and + chunk_x parameter set (netcdf_structured) to have an effect. + chunk_face : integer + is the keyword used to provide a data chunk size for the face dimension in a + netcdf_mesh2d output file. must be used in combination with the the chunk_time + parameter to have an effect. + chunk_z : integer + is the keyword used to provide a data chunk size for the z dimension in a + netcdf_structured output file. must be used in combination with the the + chunk_time, chunk_x and chunk_y parameter set to have an effect. + chunk_y : integer + is the keyword used to provide a data chunk size for the y dimension in a + netcdf_structured output file. must be used in combination with the the + chunk_time, chunk_x and chunk_z parameter set to have an effect. + chunk_x : integer + is the keyword used to provide a data chunk size for the x dimension in a + netcdf_structured output file. must be used in combination with the the + chunk_time, chunk_y and chunk_z parameter set to have an effect. + modflow6_attr_off : keyword + 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. + ncpl : integer + is the number of cells in a projected plane layer. + latitude : [double precision] + cell center latitude. only supported for netcdf_structured export type. + longitude : [double precision] + cell center longitude. only supported for netcdf_structured export type. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__( parent_package, "ncf", filename, pname, loading_package, **kwargs ) - # set up variables self.wkt = self.build_mfdata("wkt", wkt) self.deflate = self.build_mfdata("deflate", deflate) self.shuffle = self.build_mfdata("shuffle", shuffle) @@ -218,10 +262,11 @@ def __init__( self.ncpl = self.build_mfdata("ncpl", ncpl) self.latitude = self.build_mfdata("latitude", latitude) self.longitude = self.build_mfdata("longitude", longitude) + self._init_complete = True -class UtlncfPackages(mfpackage.MFChildPackages): +class UtlncfPackages(MFChildPackages): """ UtlncfPackages is a container class for the ModflowUtlncf class. @@ -234,6 +279,7 @@ class UtlncfPackages(mfpackage.MFChildPackages): append_package Adds a new ModflowUtlncf package to the container. See ModflowUtlncf init documentation for definition of parameters. + """ package_abbr = "utlncfpackages" diff --git a/flopy/mf6/modflow/mfutlobs.py b/flopy/mf6/modflow/mfutlobs.py index 5c039bbade..bbe27060db 100644 --- a/flopy/mf6/modflow/mfutlobs.py +++ b/flopy/mf6/modflow/mfutlobs.py @@ -1,74 +1,33 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowUtlobs(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowUtlobs(MFPackage): """ - ModflowUtlobs defines a obs package within a utl model. + ModflowUtlobs defines a OBS package. Parameters ---------- - parent_model_or_package : MFModel/MFPackage - Parent_model_or_package that this package is a part of. Package is automatically - added to parent_model_or_package when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. digits : integer - * digits (integer) 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. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of - observation information will be written to the listing file - immediately after it is read. - continuous : [obsname, obstype, id, id2] - * obsname (string) 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. - * obstype (string) a string of characters used to identify the - observation type. - * id (string) 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). This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * id2 (string) 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. This argument is an index - variable, which means that it should be treated as zero-based when - working with FloPy and Python. Flopy will automatically subtract one - when loading index variables and add one when writing index - variables. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + print_input : keyword + keyword to indicate that the list of observation information will be written to + the listing file immediately after it is read. + continuous : list """ @@ -76,12 +35,8 @@ class ModflowUtlobs(mfpackage.MFPackage): package_abbr = "utlobs" _package_type = "obs" dfn_file_name = "utl-obs.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name digits", @@ -196,18 +151,55 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowUtlobs defines a OBS package. + + Parameters + ---------- + parent_model_or_package + Parent_model_or_package that this package is a part of. Package is automatically + added to parent_model_or_package when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + digits : integer + 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. + print_input : keyword + keyword to indicate that the list of observation information will be written to + the listing file immediately after it is read. + continuous : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__( parent_model_or_package, "obs", filename, pname, loading_package, **kwargs ) - # set up variables self.digits = self.build_mfdata("digits", digits) self.print_input = self.build_mfdata("print_input", print_input) self.continuous = self.build_mfdata("continuous", continuous) + self._init_complete = True -class UtlobsPackages(mfpackage.MFChildPackages): +class UtlobsPackages(MFChildPackages): """ UtlobsPackages is a container class for the ModflowUtlobs class. @@ -217,12 +209,21 @@ class UtlobsPackages(mfpackage.MFChildPackages): Initializes a new ModflowUtlobs package removing any sibling child packages attached to the same parent package. See ModflowUtlobs init documentation for definition of parameters. + append_package + Adds a new ModflowUtlobs package to the container. See ModflowUtlobs + init documentation for definition of parameters. + """ package_abbr = "utlobspackages" def initialize( - self, digits=None, print_input=None, continuous=None, filename=None, pname=None + self, + digits=None, + print_input=None, + continuous=None, + filename=None, + pname=None, ): new_package = ModflowUtlobs( self._cpparent, diff --git a/flopy/mf6/modflow/mfutlsfrtab.py b/flopy/mf6/modflow/mfutlsfrtab.py index 50c051120d..d7864a41ff 100644 --- a/flopy/mf6/modflow/mfutlsfrtab.py +++ b/flopy/mf6/modflow/mfutlsfrtab.py @@ -1,60 +1,26 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowUtlsfrtab(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowUtlsfrtab(MFPackage): """ - ModflowUtlsfrtab defines a sfrtab package within a utl model. + ModflowUtlsfrtab defines a SFRTAB package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. nrow : integer - * nrow (integer) integer value specifying the number of rows in the - reach cross-section table. There must be NROW rows of data in the - TABLE block. + integer value specifying the number of rows in the reach cross-section table. + there must be nrow rows of data in the table block. ncol : integer - * ncol (integer) 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. - table : [xfraction, height, manfraction] - * xfraction (double) 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). - * height (double) 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. - * manfraction (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + 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. + table : [list] """ @@ -62,12 +28,8 @@ class ModflowUtlsfrtab(mfpackage.MFPackage): package_abbr = "utlsfrtab" _package_type = "sfrtab" dfn_file_name = "utl-sfrtab.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block dimensions", "name nrow", @@ -130,10 +92,40 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowUtlsfrtab defines a SFRTAB package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + nrow : integer + integer value specifying the number of rows in the reach cross-section table. + there must be nrow rows of data in the table block. + ncol : integer + 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. + table : [list] + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "sfrtab", filename, pname, loading_package, **kwargs) - # set up variables self.nrow = self.build_mfdata("nrow", nrow) self.ncol = self.build_mfdata("ncol", ncol) self.table = self.build_mfdata("table", table) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfutlspc.py b/flopy/mf6/modflow/mfutlspc.py index 2e5f3826a6..00d4341f6a 100644 --- a/flopy/mf6/modflow/mfutlspc.py +++ b/flopy/mf6/modflow/mfutlspc.py @@ -1,67 +1,30 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowUtlspc(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowUtlspc(MFPackage): """ - ModflowUtlspc defines a spc package within a utl model. + ModflowUtlspc defines a SPC package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of spc - information will be written to the listing file immediately after it - is read. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. + print_input : keyword + keyword to indicate that the list of spc information will be written to the + listing file immediately after it is read. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. maxbound : integer - * maxbound (integer) integer value specifying the maximum number of spc - cells that will be specified for use during any stress period. - perioddata : [bndno, spcsetting] - * bndno (integer) 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. - This argument is an index variable, which means that it should be - treated as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * spcsetting (keystring) 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. - concentration : [double] - * concentration (double) 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. - temperature : [double] - * temperature (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + integer value specifying the maximum number of spc cells that will be specified + for use during any stress period. + perioddata : list """ @@ -70,12 +33,8 @@ class ModflowUtlspc(mfpackage.MFPackage): package_abbr = "utlspc" _package_type = "spc" dfn_file_name = "utl-spc.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name print_input", @@ -204,9 +163,42 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowUtlspc defines a SPC package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + print_input : keyword + keyword to indicate that the list of spc information will be written to the + listing file immediately after it is read. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + maxbound : integer + integer value specifying the maximum number of spc cells that will be specified + for use during any stress period. + perioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "spc", filename, pname, loading_package, **kwargs) - # set up variables self.print_input = self.build_mfdata("print_input", print_input) self._ts_filerecord = self.build_mfdata("ts_filerecord", None) self._ts_package = self.build_child_package( @@ -214,4 +206,5 @@ def __init__( ) self.maxbound = self.build_mfdata("maxbound", maxbound) self.perioddata = self.build_mfdata("perioddata", perioddata) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfutlspca.py b/flopy/mf6/modflow/mfutlspca.py index eb51c172a3..beb3b6b78a 100644 --- a/flopy/mf6/modflow/mfutlspca.py +++ b/flopy/mf6/modflow/mfutlspca.py @@ -1,57 +1,41 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowUtlspca(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowUtlspca(MFPackage): """ - ModflowUtlspca defines a spca package within a utl model. + ModflowUtlspca defines a SPCA package. Parameters ---------- - model : MFModel - Model that this package is a part of. Package is automatically - added to model when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - readasarrays : boolean - * readasarrays (boolean) 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. - print_input : boolean - * print_input (boolean) keyword to indicate that the list of spc - information will be written to the listing file immediately after it - is read. - timearrayseries : {varname:data} or tas_array data - * Contains data for the tas package. Data can be stored in a dictionary - containing data for the tas package with variable names as keys and - package data as values. Data just for the timearrayseries variable is - also acceptable. See tas package documentation for more information. - concentration : [double] - * concentration (double) 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). - temperature : [double] - * temperature (double) 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). - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + readasarrays : keyword + 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. + print_input : keyword + keyword to indicate that the list of spc information will be written to the + listing file immediately after it is read. + timearrayseries : record tas6 filein tas6_filename + Contains data for the tas package. Data can be passed as a dictionary to the + tas package with variable names as keys and package data as values. Data for + the timearrayseries variable is also acceptable. See tas package documentation + for more information. + concentration : [double precision] + 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). + temperature : [double precision] + 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). """ @@ -61,12 +45,8 @@ class ModflowUtlspca(mfpackage.MFPackage): package_abbr = "utlspca" _package_type = "spca" dfn_file_name = "utl-spca.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block options", "name readasarrays", @@ -74,7 +54,7 @@ class ModflowUtlspca(mfpackage.MFPackage): "shape", "reader urword", "optional false", - "default_value True", + "default True", ], [ "block options", @@ -92,8 +72,8 @@ class ModflowUtlspca(mfpackage.MFPackage): "tagged true", "optional true", "construct_package tas", - "construct_data tas_array", - "parameter_name timearrayseries", + "construct_data timearrayseries", + "parameter_name tas_array", ], [ "block options", @@ -168,9 +148,53 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowUtlspca defines a SPCA package. + + Parameters + ---------- + model + Model that this package is a part of. Package is automatically + added to model when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + readasarrays : keyword + 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. + print_input : keyword + keyword to indicate that the list of spc information will be written to the + listing file immediately after it is read. + timearrayseries : record tas6 filein tas6_filename + Contains data for the tas package. Data can be passed as a dictionary to the + tas package with variable names as keys and package data as values. Data for + the timearrayseries variable is also acceptable. See tas package documentation + for more information. + concentration : [double precision] + 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). + temperature : [double precision] + 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). + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__(model, "spca", filename, pname, loading_package, **kwargs) - # set up variables self.readasarrays = self.build_mfdata("readasarrays", readasarrays) self.print_input = self.build_mfdata("print_input", print_input) self._tas_filerecord = self.build_mfdata("tas_filerecord", None) @@ -179,4 +203,5 @@ def __init__( ) self.concentration = self.build_mfdata("concentration", concentration) self.temperature = self.build_mfdata("temperature", temperature) + self._init_complete = True diff --git a/flopy/mf6/modflow/mfutltas.py b/flopy/mf6/modflow/mfutltas.py index d63892b17e..e611c77518 100644 --- a/flopy/mf6/modflow/mfutltas.py +++ b/flopy/mf6/modflow/mfutltas.py @@ -1,44 +1,44 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowUtltas(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowUtltas(MFPackage): """ - ModflowUtltas defines a tas package within a utl model. + ModflowUtltas defines a TAS package. Parameters ---------- - parent_package : MFPackage - Parent_package that this package is a part of. Package is automatically - added to parent_package when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - time_series_namerecord : [time_series_name] - * time_series_name (string) 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. - interpolation_methodrecord : [interpolation_method] - * interpolation_method (string) Interpolation method, which is either - STEPWISE or LINEAR. - sfacrecord : [sfacval] - * sfacval (double) Scale factor, which will multiply all array values - in time series. SFAC is an optional attribute; if omitted, SFAC = - 1.0. - tas_array : [double] - * tas_array (double) An array of numeric, floating-point values, or a - constant value, readable by the U2DREL array-reading utility. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + time_series_namerecord : (name, time_series_name) + xxx + * name : keyword + xxx + * time_series_name : [string] + 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. + + interpolation_methodrecord : (method, interpolation_method) + xxx + * method : keyword + xxx + * interpolation_method : string + Interpolation method, which is either STEPWISE or LINEAR. + + sfacrecord : (sfac, sfacval) + xxx + * sfac : keyword + xxx + * sfacval : [double precision] + Scale factor, which will multiply all array values in time series. SFAC is an + optional attribute; if omitted, SFAC = 1.0. + + tas_array : [double precision] + an array of numeric, floating-point values, or a constant value, readable by + the u2drel array-reading utility. """ @@ -53,12 +53,8 @@ class ModflowUtltas(mfpackage.MFPackage): package_abbr = "utltas" _package_type = "tas" dfn_file_name = "utl-tas.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block attributes", "name time_series_namerecord", @@ -181,11 +177,58 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowUtltas defines a TAS package. + + Parameters + ---------- + parent_package + Parent_package that this package is a part of. Package is automatically + added to parent_package when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + time_series_namerecord : (name, time_series_name) + xxx + * name : keyword + xxx + * time_series_name : [string] + 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. + + interpolation_methodrecord : (method, interpolation_method) + xxx + * method : keyword + xxx + * interpolation_method : string + Interpolation method, which is either STEPWISE or LINEAR. + + sfacrecord : (sfac, sfacval) + xxx + * sfac : keyword + xxx + * sfacval : [double precision] + Scale factor, which will multiply all array values in time series. SFAC is an + optional attribute; if omitted, SFAC = 1.0. + + tas_array : [double precision] + an array of numeric, floating-point values, or a constant value, readable by + the u2drel array-reading utility. + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__( parent_package, "tas", filename, pname, loading_package, **kwargs ) - # set up variables self.time_series_namerecord = self.build_mfdata( "time_series_namerecord", time_series_namerecord ) @@ -194,10 +237,11 @@ def __init__( ) self.sfacrecord = self.build_mfdata("sfacrecord", sfacrecord) self.tas_array = self.build_mfdata("tas_array", tas_array) + self._init_complete = True -class UtltasPackages(mfpackage.MFChildPackages): +class UtltasPackages(MFChildPackages): """ UtltasPackages is a container class for the ModflowUtltas class. @@ -210,6 +254,7 @@ class UtltasPackages(mfpackage.MFChildPackages): append_package Adds a new ModflowUtltas package to the container. See ModflowUtltas init documentation for definition of parameters. + """ package_abbr = "utltaspackages" diff --git a/flopy/mf6/modflow/mfutlts.py b/flopy/mf6/modflow/mfutlts.py index 77a24ee068..78dd7ab561 100644 --- a/flopy/mf6/modflow/mfutlts.py +++ b/flopy/mf6/modflow/mfutlts.py @@ -1,54 +1,57 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowUtlts(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowUtlts(MFPackage): """ - ModflowUtlts defines a ts package within a utl model. + ModflowUtlts defines a TS package. Parameters ---------- - parent_package : MFPackage - Parent_package that this package is a part of. Package is automatically - added to parent_package when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - time_series_namerecord : [time_series_names] - * time_series_names (string) 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. - interpolation_methodrecord : [interpolation_method] - * interpolation_method (string) Interpolation method, which is either - STEPWISE or LINEAR. - interpolation_methodrecord_single : [interpolation_method_single] - * interpolation_method_single (string) Interpolation method, which is - either STEPWISE or LINEAR. - sfacrecord : [sfacval] - * sfacval (double) Scale factor, which will multiply all array values - in time series. SFAC is an optional attribute; if omitted, SFAC = - 1.0. - sfacrecord_single : [sfacval] - * sfacval (double) Scale factor, which will multiply all array values - in time series. SFAC is an optional attribute; if omitted, SFAC = - 1.0. - timeseries : [ts_time, ts_array] - * ts_time (double) A numeric time relative to the start of the - simulation, in the time unit used in the simulation. Times must be - strictly increasing. - * ts_array (double) A 2-D array of numeric, floating-point values, or a - constant value, readable by the U2DREL array-reading utility. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + time_series_namerecord : (names, time_series_names) + xxx + * names : keyword + xxx + * time_series_names : [string] + 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. + + interpolation_methodrecord : (methods, interpolation_method) + xxx + * methods : keyword + xxx + * interpolation_method : [string] + Interpolation method, which is either STEPWISE or LINEAR. + + interpolation_methodrecord_single : record + xxx + method : keyword + xxx + interpolation_method_single : string + interpolation method, which is either stepwise or linear. + sfacrecord : (sfacs, sfacval) + xxx + * sfacs : keyword + xxx + * sfacval : [double precision] + Scale factor, which will multiply all array values in time series. SFAC is an + optional attribute; if omitted, SFAC = 1.0. + + sfacrecord_single : (sfacval) + xxx + * sfacval : [double precision] + Scale factor, which will multiply all array values in time series. SFAC is an + optional attribute; if omitted, SFAC = 1.0. + + sfac : keyword + xxx + timeseries : list + xxx """ @@ -67,12 +70,8 @@ class ModflowUtlts(mfpackage.MFPackage): package_abbr = "utlts" _package_type = "ts" dfn_file_name = "utl-ts.dfn" - dfn = [ - [ - "header", - "multi-package", - ], + ["header", "multi-package"], [ "block attributes", "name time_series_namerecord", @@ -250,11 +249,71 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowUtlts defines a TS package. + + Parameters + ---------- + parent_package + Parent_package that this package is a part of. Package is automatically + added to parent_package when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + time_series_namerecord : (names, time_series_names) + xxx + * names : keyword + xxx + * time_series_names : [string] + 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. + + interpolation_methodrecord : (methods, interpolation_method) + xxx + * methods : keyword + xxx + * interpolation_method : [string] + Interpolation method, which is either STEPWISE or LINEAR. + + interpolation_methodrecord_single : record + xxx + method : keyword + xxx + interpolation_method_single : string + interpolation method, which is either stepwise or linear. + sfacrecord : (sfacs, sfacval) + xxx + * sfacs : keyword + xxx + * sfacval : [double precision] + Scale factor, which will multiply all array values in time series. SFAC is an + optional attribute; if omitted, SFAC = 1.0. + + sfacrecord_single : (sfacval) + xxx + * sfacval : [double precision] + Scale factor, which will multiply all array values in time series. SFAC is an + optional attribute; if omitted, SFAC = 1.0. + + sfac : keyword + xxx + timeseries : list + xxx + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__( parent_package, "ts", filename, pname, loading_package, **kwargs ) - # set up variables self.time_series_namerecord = self.build_mfdata( "time_series_namerecord", time_series_namerecord ) @@ -269,10 +328,11 @@ def __init__( "sfacrecord_single", sfacrecord_single ) self.timeseries = self.build_mfdata("timeseries", timeseries) + self._init_complete = True -class UtltsPackages(mfpackage.MFChildPackages): +class UtltsPackages(MFChildPackages): """ UtltsPackages is a container class for the ModflowUtlts class. @@ -285,6 +345,7 @@ class UtltsPackages(mfpackage.MFChildPackages): append_package Adds a new ModflowUtlts package to the container. See ModflowUtlts init documentation for definition of parameters. + """ package_abbr = "utltspackages" diff --git a/flopy/mf6/modflow/mfutltvk.py b/flopy/mf6/modflow/mfutltvk.py index 4642fc1812..1e74c1e3a6 100644 --- a/flopy/mf6/modflow/mfutltvk.py +++ b/flopy/mf6/modflow/mfutltvk.py @@ -1,80 +1,27 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowUtltvk(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowUtltvk(MFPackage): """ - ModflowUtltvk defines a tvk package within a utl model. + ModflowUtltvk defines a TVK package. Parameters ---------- - parent_package : MFPackage - Parent_package that this package is a part of. Package is automatically - added to parent_package when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - print_input : boolean - * print_input (boolean) keyword to indicate that information for each - change to the hydraulic conductivity in a cell will be written to the - model listing file. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - perioddata : [cellid, tvksetting] - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * tvksetting (keystring) 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. - k : [double] - * k (double) 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. - k22 : [double] - * k22 (double) 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. - k33 : [double] - * k33 (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + print_input : keyword + keyword to indicate that information for each change to the hydraulic + conductivity in a cell will be written to the model listing file. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + perioddata : list """ @@ -83,11 +30,8 @@ class ModflowUtltvk(mfpackage.MFPackage): package_abbr = "utltvk" _package_type = "tvk" dfn_file_name = "utl-tvk.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name print_input", @@ -217,21 +161,52 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowUtltvk defines a TVK package. + + Parameters + ---------- + parent_package + Parent_package that this package is a part of. Package is automatically + added to parent_package when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + print_input : keyword + keyword to indicate that information for each change to the hydraulic + conductivity in a cell will be written to the model listing file. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + perioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__( parent_package, "tvk", filename, pname, loading_package, **kwargs ) - # set up variables self.print_input = self.build_mfdata("print_input", print_input) self._ts_filerecord = self.build_mfdata("ts_filerecord", None) self._ts_package = self.build_child_package( "ts", timeseries, "timeseries", self._ts_filerecord ) self.perioddata = self.build_mfdata("perioddata", perioddata) + self._init_complete = True -class UtltvkPackages(mfpackage.MFChildPackages): +class UtltvkPackages(MFChildPackages): """ UtltvkPackages is a container class for the ModflowUtltvk class. @@ -244,6 +219,7 @@ class UtltvkPackages(mfpackage.MFChildPackages): append_package Adds a new ModflowUtltvk package to the container. See ModflowUtltvk init documentation for definition of parameters. + """ package_abbr = "utltvkpackages" diff --git a/flopy/mf6/modflow/mfutltvs.py b/flopy/mf6/modflow/mfutltvs.py index 091d7b4476..186a34e983 100644 --- a/flopy/mf6/modflow/mfutltvs.py +++ b/flopy/mf6/modflow/mfutltvs.py @@ -1,78 +1,33 @@ -# DO NOT MODIFY THIS FILE DIRECTLY. THIS FILE MUST BE CREATED BY -# mf6/utils/createpackages.py -# FILE created on February 11, 2025 01:24:12 UTC -from .. import mfpackage -from ..data.mfdatautil import ListTemplateGenerator +# autogenerated file, do not modify +from os import PathLike, curdir +from typing import Union -class ModflowUtltvs(mfpackage.MFPackage): +from flopy.mf6.data.mfdatautil import ArrayTemplateGenerator, ListTemplateGenerator +from flopy.mf6.mfpackage import MFChildPackages, MFPackage + + +class ModflowUtltvs(MFPackage): """ - ModflowUtltvs defines a tvs package within a utl model. + ModflowUtltvs defines a TVS package. Parameters ---------- - parent_package : MFPackage - Parent_package that this package is a part of. Package is automatically - added to parent_package when it is initialized. - loading_package : bool - Do not set this parameter. It is intended for debugging and internal - processing purposes only. - disable_storage_change_integration : boolean - * disable_storage_change_integration (boolean) 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. - print_input : boolean - * print_input (boolean) keyword to indicate that information for each - change to a storage property in a cell will be written to the model - listing file. - timeseries : {varname:data} or timeseries data - * Contains data for the ts package. Data can be stored in a dictionary - containing data for the ts package with variable names as keys and - package data as values. Data just for the timeseries variable is also - acceptable. See ts package documentation for more information. - perioddata : [cellid, tvssetting] - * cellid ((integer, ...)) 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. This - argument is an index variable, which means that it should be treated - as zero-based when working with FloPy and Python. Flopy will - automatically subtract one when loading index variables and add one - when writing index variables. - * tvssetting (keystring) 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. - ss : [double] - * ss (double) 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. - sy : [double] - * sy (double) 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. - filename : String - File name for this package. - pname : String - Package name for this package. - parent_file : MFPackage - Parent package file that references this package. Only needed for - utility packages (mfutl*). For example, mfutllaktab package must have - a mfgwflak package parent_file. + disable_storage_change_integration : keyword + 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. + print_input : keyword + keyword to indicate that information for each change to a storage property in a + cell will be written to the model listing file. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + perioddata : list """ @@ -81,11 +36,8 @@ class ModflowUtltvs(mfpackage.MFPackage): package_abbr = "utltvs" _package_type = "tvs" dfn_file_name = "utl-tvs.dfn" - dfn = [ - [ - "header", - ], + ["header"], [ "block options", "name disable_storage_change_integration", @@ -213,11 +165,47 @@ def __init__( pname=None, **kwargs, ): + """ + ModflowUtltvs defines a TVS package. + + Parameters + ---------- + parent_package + Parent_package that this package is a part of. Package is automatically + added to parent_package when it is initialized. + loading_package : bool + Do not set this parameter. It is intended for debugging and internal + processing purposes only. + disable_storage_change_integration : keyword + 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. + print_input : keyword + keyword to indicate that information for each change to a storage property in a + cell will be written to the model listing file. + timeseries : record ts6 filein ts6_filename + Contains data for the ts package. Data can be passed as a dictionary to the ts + package with variable names as keys and package data as values. Data for the + timeseries variable is also acceptable. See ts package documentation for more + information. + perioddata : list + + filename : str + File name for this package. + pname : str + Package name for this package. + parent_file : MFPackage + Parent package file that references this package. Only needed for + utility packages (mfutl*). For example, mfutllaktab package must have + a mfgwflak package parent_file. + """ + super().__init__( parent_package, "tvs", filename, pname, loading_package, **kwargs ) - # set up variables self.disable_storage_change_integration = self.build_mfdata( "disable_storage_change_integration", disable_storage_change_integration ) @@ -227,10 +215,11 @@ def __init__( "ts", timeseries, "timeseries", self._ts_filerecord ) self.perioddata = self.build_mfdata("perioddata", perioddata) + self._init_complete = True -class UtltvsPackages(mfpackage.MFChildPackages): +class UtltvsPackages(MFChildPackages): """ UtltvsPackages is a container class for the ModflowUtltvs class. @@ -243,6 +232,7 @@ class UtltvsPackages(mfpackage.MFChildPackages): append_package Adds a new ModflowUtltvs package to the container. See ModflowUtltvs init documentation for definition of parameters. + """ package_abbr = "utltvspackages" diff --git a/flopy/version.py b/flopy/version.py index 134ccb998c..3052d1b020 100644 --- a/flopy/version.py +++ b/flopy/version.py @@ -1,4 +1,4 @@ # flopy version file automatically created using -# update_version.py on February 12, 2025 07:12:43 +# update_version.py on May 13, 2025 07:41:35 -__version__ = "3.10.0.dev2" +__version__ = "3.10.0.dev3" diff --git a/version.txt b/version.txt index 992d199d44..399077a7f7 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -3.10.0.dev2 \ No newline at end of file +3.10.0.dev3 \ No newline at end of file