Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mf6: update dfns and mf6 module #2399

Merged
merged 3 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions flopy/mf6/data/dfn/exg-gwegwe.dfn
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ 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'' 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.
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.

block options
name boundnames
Expand Down Expand Up @@ -162,7 +162,7 @@ tagged false
reader urword
optional false
longname obs6 input filename
description is the file name of the observations input file for this exchange. See the ``Observation utility'' section for instructions for preparing observation input files. Table \ref{table:gwe-obstypetable} lists observation type(s) supported by the GWE-GWE package.
description is the file name of the observations input file for this exchange. See the ``Observation utility'' section for instructions for preparing observation input files. Table \ref{table:gwe-obstypetable} lists observation type(s) supported by the GWE-GWE Exchange Package.

block options
name dev_interfacemodel_on
Expand Down
19 changes: 18 additions & 1 deletion flopy/mf6/data/dfn/gwe-cnd.dfn
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,16 @@ mf6internal export_ascii
longname export array variables to layered ascii files.
description keyword that specifies input griddata arrays should be written to layered ascii output files.

block options
name export_array_netcdf
type keyword
reader urword
optional true
mf6internal export_nc
longname export array variables to netcdf output files.
description keyword that specifies input griddata arrays should be written to the model output netcdf file.
extended true

# --------------------- gwe cnd griddata ---------------------

block griddata
Expand All @@ -35,6 +45,7 @@ type double precision
shape (nodes)
reader readarray
layered true
netcdf true
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.
Expand All @@ -45,6 +56,7 @@ type double precision
shape (nodes)
reader readarray
layered true
netcdf true
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.
Expand All @@ -55,6 +67,7 @@ type double precision
shape (nodes)
reader readarray
layered true
netcdf true
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.
Expand All @@ -65,6 +78,7 @@ type double precision
shape (nodes)
reader readarray
layered true
netcdf true
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.
Expand All @@ -75,6 +89,7 @@ type double precision
shape (nodes)
reader readarray
layered true
netcdf true
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.
Expand All @@ -85,6 +100,7 @@ type double precision
shape (nodes)
reader readarray
layered true
netcdf true
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.
Expand All @@ -95,7 +111,8 @@ type double precision
shape (nodes)
reader readarray
layered true
netcdf true
optional true
longname thermal conductivity of the aquifer material
description thermal conductivity of the aquifer material
description thermal conductivity of the solid aquifer material

2 changes: 1 addition & 1 deletion flopy/mf6/data/dfn/gwe-ctp.dfn
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ type integer
reader urword
optional false
longname maximum number of constant temperatures
description REPLACE maxbound {'{#1}': 'constant temperatures'}
description REPLACE maxbound {'{#1}': 'constant temperature'}


# --------------------- gwe ctp period ---------------------
Expand Down
58 changes: 58 additions & 0 deletions flopy/mf6/data/dfn/gwe-dis.dfn
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# --------------------- gwe dis options ---------------------
# mf6 subpackage utl-ncf

block options
name length_units
Expand Down Expand Up @@ -49,6 +50,58 @@ mf6internal export_ascii
longname export array variables to layered ascii files.
description keyword that specifies input griddata arrays should be written to layered ascii output files.

block options
name export_array_netcdf
type keyword
reader urword
optional true
mf6internal export_nc
longname export array variables to netcdf output files.
description keyword that specifies input griddata arrays should be written to the model output netcdf file.
extended true

block options
name ncf_filerecord
type record ncf6 filein ncf6_filename
reader urword
tagged true
optional true
longname
description

block options
name ncf6
type keyword
in_record true
reader urword
tagged true
optional false
longname ncf keyword
description keyword to specify that record corresponds to a netcdf configuration (NCF) file.
extended true

block options
name filein
type keyword
in_record true
reader urword
tagged true
optional false
longname file keyword
description keyword to specify that an input filename is expected next.

block options
name ncf6_filename
type string
preserve_case true
in_record true
reader urword
optional false
tagged false
longname file name of NCF information
description defines a netcdf configuration (NCF) input file.
extended true

# --------------------- gwe dis dimensions ---------------------

block dimensions
Expand Down Expand Up @@ -85,6 +138,7 @@ name delr
type double precision
shape (ncol)
reader readarray
netcdf true
longname spacing along a row
description is the column spacing in the row direction.
default_value 1.0
Expand All @@ -94,6 +148,7 @@ name delc
type double precision
shape (nrow)
reader readarray
netcdf true
longname spacing along a column
description is the row spacing in the column direction.
default_value 1.0
Expand All @@ -103,6 +158,7 @@ name top
type double precision
shape (ncol, nrow)
reader readarray
netcdf true
longname cell top elevation
description is the top elevation for each cell in the top model layer.
default_value 1.0
Expand All @@ -113,6 +169,7 @@ type double precision
shape (ncol, nrow, nlay)
reader readarray
layered true
netcdf true
longname cell bottom elevation
description is the bottom elevation for each cell.
default_value 0.
Expand All @@ -123,6 +180,7 @@ type integer
shape (ncol, nrow, nlay)
reader readarray
layered true
netcdf true
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.
Expand Down
56 changes: 56 additions & 0 deletions flopy/mf6/data/dfn/gwe-disv.dfn
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# --------------------- gwe disv options ---------------------
# mf6 subpackage utl-ncf

block options
name length_units
Expand Down Expand Up @@ -49,6 +50,58 @@ mf6internal export_ascii
longname export array variables to layered ascii files.
description keyword that specifies input griddata arrays should be written to layered ascii output files.

block options
name export_array_netcdf
type keyword
reader urword
optional true
mf6internal export_nc
longname export array variables to netcdf output files.
description keyword that specifies input griddata arrays should be written to the model output netcdf file.
extended true

block options
name ncf_filerecord
type record ncf6 filein ncf6_filename
reader urword
tagged true
optional true
longname
description

block options
name ncf6
type keyword
in_record true
reader urword
tagged true
optional false
longname ncf keyword
description keyword to specify that record corresponds to a netcdf configuration (NCF) file.
extended true

block options
name filein
type keyword
in_record true
reader urword
tagged true
optional false
longname file keyword
description keyword to specify that an input filename is expected next.

block options
name ncf6_filename
type string
preserve_case true
in_record true
reader urword
optional false
tagged false
longname file name of NCF information
description defines a netcdf configuration (NCF) input file.
extended true

# --------------------- gwe disv dimensions ---------------------

block dimensions
Expand Down Expand Up @@ -82,6 +135,7 @@ name top
type double precision
shape (ncpl)
reader readarray
netcdf true
longname model top elevation
description is the top elevation for each cell in the top model layer.

Expand All @@ -91,6 +145,7 @@ type double precision
shape (ncpl, nlay)
reader readarray
layered true
netcdf true
longname model bottom elevation
description is the bottom elevation for each cell.

Expand All @@ -100,6 +155,7 @@ type integer
shape (ncpl, nlay)
reader readarray
layered true
netcdf true
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.
Expand Down
2 changes: 1 addition & 1 deletion flopy/mf6/data/dfn/gwe-esl.dfn
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ type integer
reader urword
optional false
longname maximum number of sources
description REPLACE maxbound {'{#1}': 'sources'}
description REPLACE maxbound {'{#1}': 'source'}


# --------------------- gwe esl period ---------------------
Expand Down
Loading
Loading