From 67ee03d80e684615b69e0f36f740250be1b512b2 Mon Sep 17 00:00:00 2001 From: Christian Langevin Date: Tue, 17 Sep 2019 10:28:48 -0400 Subject: [PATCH] docs(dfn): update some MODFLOW 6 variable descriptions --- flopy/mf6/data/dfn/gwf-dis.dfn | 4 ++-- flopy/mf6/data/dfn/gwf-evt.dfn | 4 ++-- flopy/mf6/data/dfn/gwf-uzf.dfn | 4 ++-- flopy/mf6/data/dfn/sln-ims.dfn | 24 ++++++++++++++++++++++-- flopy/mf6/modflow/mfgwfdis.py | 4 ++-- flopy/mf6/modflow/mfgwfdisu.py | 2 +- flopy/mf6/modflow/mfgwfevt.py | 5 +++-- flopy/mf6/modflow/mfgwfuzf.py | 12 ++++++------ 8 files changed, 40 insertions(+), 19 deletions(-) diff --git a/flopy/mf6/data/dfn/gwf-dis.dfn b/flopy/mf6/data/dfn/gwf-dis.dfn index d7ca2a675c..2b71d836c4 100644 --- a/flopy/mf6/data/dfn/gwf-dis.dfn +++ b/flopy/mf6/data/dfn/gwf-dis.dfn @@ -78,7 +78,7 @@ type double precision shape (ncol) reader readarray longname spacing along a row -description is the is the column spacing in the row direction. +description is the column spacing in the row direction. default_value 1.0 block griddata @@ -87,7 +87,7 @@ type double precision shape (nrow) reader readarray longname spacing along a column -description is the is the row spacing in the column direction. +description is the row spacing in the column direction. default_value 1.0 block griddata diff --git a/flopy/mf6/data/dfn/gwf-evt.dfn b/flopy/mf6/data/dfn/gwf-evt.dfn index fecad11902..8bd1852847 100644 --- a/flopy/mf6/data/dfn/gwf-evt.dfn +++ b/flopy/mf6/data/dfn/gwf-evt.dfn @@ -140,8 +140,8 @@ name surf_rate_specified type keyword reader urword optional true -longname specify evapotranspiration rate at ET surface -description indicates that the evapotranspiration rate at the ET surface will be specified as PETM0 in list input. +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. # --------------------- gwf evt dimensions --------------------- diff --git a/flopy/mf6/data/dfn/gwf-uzf.dfn b/flopy/mf6/data/dfn/gwf-uzf.dfn index c99df615bf..faf51e07dc 100644 --- a/flopy/mf6/data/dfn/gwf-uzf.dfn +++ b/flopy/mf6/data/dfn/gwf-uzf.dfn @@ -250,7 +250,7 @@ type integer reader urword optional false longname number of trailing waves -description is the number of trailing waves. NTRAILWAVES has a default value of 7 and can be increased to lower mass balance error in the unsaturated zone. +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. block dimensions name nwavesets @@ -258,7 +258,7 @@ type integer reader urword optional false longname number of wave sets -description is the number of UZF cells specified. NWAVESETS has a default value of 40 and can be increased if more waves are required to resolve variations in water content within the unsaturated zone. +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. # --------------------- gwf uzf packagedata --------------------- diff --git a/flopy/mf6/data/dfn/sln-ims.dfn b/flopy/mf6/data/dfn/sln-ims.dfn index 84bd5eb046..b5091e8bed 100644 --- a/flopy/mf6/data/dfn/sln-ims.dfn +++ b/flopy/mf6/data/dfn/sln-ims.dfn @@ -60,13 +60,33 @@ optional false longname file keyword description name of the ascii comma separated values output file to write solver convergence information. If PRINT\_OPTION is NONE or SUMMARY, comma separated values output includes maximum head change convergence information at the end of each outer iteration for each time step. If PRINT\_OPTION is ALL, comma separated values output includes maximum head change and maximum residual convergence information for the solution and each model (if the solution includes more than one model) and linear acceleration information for each inner iteration. +block options +name no_ptcrecord +type record no_ptc no_ptc_option +reader urword +optional true +longname no_ptc record +description + block options name no_ptc type keyword +in_record true reader urword -optional true +optional false +tagged true longname no pseudo-transient continuation -description is a flag that is used to disable pseudo-transient continuation (PTC). Option only applies to steady-state stress periods for models using the Newton-Raphson formulation. For many problems, PTC can significantly improve convergence behavior for steady-state simulations, and for this reason it is active by default. In some cases, however, PTC can worsen the convergence behavior, especially when the initial conditions are similar to the solution. When the initial conditions are similar to, or exactly the same as, the solution and convergence is slow, then this NO\_PTC option should be used to deactivate PTC. This NO\_PTC option should also be used in order to compare convergence behavior with other MODFLOW versions, as PTC is only available in MODFLOW 6. +description is a flag that is used to disable pseudo-transient continuation (PTC). Option only applies to steady-state stress periods for models using the Newton-Raphson formulation. For many problems, PTC can significantly improve convergence behavior for steady-state simulations, and for this reason it is active by default. In some cases, however, PTC can worsen the convergence behavior, especially when the initial conditions are similar to the solution. When the initial conditions are similar to, or exactly the same as, the solution and convergence is slow, then the NO\_PTC FIRST option should be used to deactivate PTC for the first stress period. The NO\_PTC ALL option should also be used in order to compare convergence behavior with other MODFLOW versions, as PTC is only available in MODFLOW 6. + +block options +name no_ptc_option +type string +in_record true +reader urword +optional true +tagged false +longname no pseudo-transient continuation option +description is an optional keyword that is used to define options for disabling pseudo-transient continuation (PTC). FIRST is an optional keyword to disable PTC for the first stress period, if steady-state and one or more model is using the Newton-Raphson formulation. ALL is an optional keyword to disable PTC for all steady-state stress periods for models using the Newton-Raphson formulation. If NO\_PTC\_OPTION is not specified, the NO\_PTC ALL option is used. # --------------------- sln ims nonlinear --------------------- diff --git a/flopy/mf6/modflow/mfgwfdis.py b/flopy/mf6/modflow/mfgwfdis.py index b879a32031..6ee747698d 100644 --- a/flopy/mf6/modflow/mfgwfdis.py +++ b/flopy/mf6/modflow/mfgwfdis.py @@ -48,9 +48,9 @@ class ModflowGwfdis(mfpackage.MFPackage): ncol : integer * ncol (integer) is the number of columns in the model grid. delr : [double] - * delr (double) is the is the column spacing in the row direction. + * delr (double) is the column spacing in the row direction. delc : [double] - * delc (double) is the is the row spacing in the column direction. + * 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. diff --git a/flopy/mf6/modflow/mfgwfdisu.py b/flopy/mf6/modflow/mfgwfdisu.py index 2089b86757..69d2cb850d 100644 --- a/flopy/mf6/modflow/mfgwfdisu.py +++ b/flopy/mf6/modflow/mfgwfdisu.py @@ -60,7 +60,7 @@ class ModflowGwfdisu(mfpackage.MFPackage): 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, these this information is required. + Package, then this information is required. top : [double] * top (double) is the top elevation for each cell in the model grid. bot : [double] diff --git a/flopy/mf6/modflow/mfgwfevt.py b/flopy/mf6/modflow/mfgwfevt.py index 1fb1c1710e..afd5349dbe 100644 --- a/flopy/mf6/modflow/mfgwfevt.py +++ b/flopy/mf6/modflow/mfgwfevt.py @@ -64,8 +64,9 @@ class ModflowGwfevt(mfpackage.MFPackage): 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 evapotranspiration - rate at the ET surface will be specified as PETM0 in list input. + * surf_rate_specified (boolean) 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 diff --git a/flopy/mf6/modflow/mfgwfuzf.py b/flopy/mf6/modflow/mfgwfuzf.py index 41dc133bdc..bed1925366 100644 --- a/flopy/mf6/modflow/mfgwfuzf.py +++ b/flopy/mf6/modflow/mfgwfuzf.py @@ -103,13 +103,13 @@ class ModflowGwfuzf(mfpackage.MFPackage): 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. NTRAILWAVES - has a default value of 7 and can be increased to lower mass balance - error in the unsaturated zone. + * 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 - * nwavesets (integer) is the number of UZF cells specified. NWAVESETS - has a default value of 40 and can be increased if more waves are - required to resolve variations in water content within the + * 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 : [iuzno, cellid, landflag, ivertcon, surfdep, vks, thtr, thts, thti, eps, boundname]