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.

Sign up for GitHub

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

docs(mf6io): standardize variable name of the feature ID in the MAW & MWT dfn files #1360

Merged
merged 2 commits into from
Sep 22, 2023
Merged

docs(mf6io): standardize variable name of the feature ID in the MAW & MWT dfn files #1360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6240b8
docs(mf6io): standardize variable name of the feature ID in the MAW &…
emorway-usgs Sep 21, 2023
73371ee
Merge branch 'develop' into standardize_feat_no_param_name_maw_mwt
langevin-usgs Sep 22, 2023
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
6 changes: 3 additions & 3 deletions autotest/test_gwf_buy_maw01.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,16 +128,16 @@ def build_model(idx, dir):
mawstrt = 3.5
mawcondeqn = "THIEM"
mawngwfnodes = nlay
# <wellno> <radius> <bottom> <strt> <condeqn> <ngwfnodes>
# <ifno> <radius> <bottom> <strt> <condeqn> <ngwfnodes>
mawpackagedata = [
[0, mawradius, mawbottom, mawstrt, mawcondeqn, mawngwfnodes, mawdense]
]
# <wellno> <icon> <cellid(ncelldim)> <scrn_top> <scrn_bot> <hk_skin> <radius_skin>
# <ifno> <icon> <cellid(ncelldim)> <scrn_top> <scrn_bot> <hk_skin> <radius_skin>
mawconnectiondata = [
[0, icon, (icon, 0, 0), top, mawbottom, -999.0, -999.0]
for icon in range(nlay)
]
# <wellno> <mawsetting>
# <ifno> <mawsetting>
mawperioddata = [[0, "STATUS", "ACTIVE"]]
maw = flopy.mf6.ModflowGwfmaw(
gwf,
Expand Down
6 changes: 3 additions & 3 deletions autotest/test_gwf_maw05.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,16 +113,16 @@ def build_model(idx, dir):
mstrt = mawstrt[idx]
mawcondeqn = "THIEM"
mawngwfnodes = nlay
# <wellno> <radius> <bottom> <strt> <condeqn> <ngwfnodes>
# <ifno> <radius> <bottom> <strt> <condeqn> <ngwfnodes>
mawpackagedata = [
[0, mawradius, mawbottom, mstrt, mawcondeqn, mawngwfnodes]
]
# <wellno> <icon> <cellid(ncelldim)> <scrn_top> <scrn_bot> <hk_skin> <radius_skin>
# <ifno> <icon> <cellid(ncelldim)> <scrn_top> <scrn_bot> <hk_skin> <radius_skin>
mawconnectiondata = [
[0, icon, (icon, 0, 0), top, mawbottom, -999.0, -999.0]
for icon in range(nlay)
]
# <wellno> <mawsetting>
# <ifno> <mawsetting>
mawperioddata = [[0, "STATUS", "ACTIVE"]]
maw = flopy.mf6.ModflowGwfmaw(
gwf,
Expand Down
6 changes: 3 additions & 3 deletions autotest/test_gwf_maw06.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,14 +132,14 @@ def build_model(idx, dir):
mstrt = mawstrt[idx]
mawcondeqn = "SPECIFIED"
mawngwfnodes = nlay
# <wellno> <radius> <bottom> <strt> <condeqn> <ngwfnodes>
# <ifno> <radius> <bottom> <strt> <condeqn> <ngwfnodes>
mawpackagedata = [[0, mawradius, bot, mstrt, mawcondeqn, mawngwfnodes]]
# <wellno> <icon> <cellid(ncelldim)> <scrn_top> <scrn_bot> <hk_skin> <radius_skin>
# <ifno> <icon> <cellid(ncelldim)> <scrn_top> <scrn_bot> <hk_skin> <radius_skin>
mawconnectiondata = [
[0, icon, (icon, 0, 0), top, bot, mawcond, -999]
for icon in range(nlay)
]
# <wellno> <mawsetting>
# <ifno> <mawsetting>
mawperioddata = [[0, "STATUS", "ACTIVE"]]
mbin = f"{gwfname}.maw.bin"
mbud = f"{gwfname}.maw.bud"
Expand Down
6 changes: 3 additions & 3 deletions autotest/test_gwf_maw07.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,14 +132,14 @@ def build_model(idx, dir):
mstrt = mawstrt[idx]
mawcondeqn = "SPECIFIED"
mawngwfnodes = nlay
# <wellno> <radius> <bottom> <strt> <condeqn> <ngwfnodes>
# <ifno> <radius> <bottom> <strt> <condeqn> <ngwfnodes>
mawpackagedata = [[0, mawradius, bot, mstrt, mawcondeqn, mawngwfnodes]]
# <wellno> <icon> <cellid(ncelldim)> <scrn_top> <scrn_bot> <hk_skin> <radius_skin>
# <ifno> <icon> <cellid(ncelldim)> <scrn_top> <scrn_bot> <hk_skin> <radius_skin>
mawconnectiondata = [
[0, icon, (icon, 0, 0), top, bot, mawcond, -999]
for icon in range(nlay)
]
# <wellno> <mawsetting>
# <ifno> <mawsetting>
mawperioddata = {}
mawperioddata[0] = [[0, "STATUS", "INACTIVE"]]
mawperioddata[1] = [[0, "STATUS", "ACTIVE"]]
Expand Down
4 changes: 2 additions & 2 deletions autotest/test_gwf_maw08.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,15 +122,15 @@ def build_model(idx, dir):
k33=Kv,
)

# <wellno> <radius> <bottom> <strt> <condeqn> <ngwfnodes>
# <ifno> <radius> <bottom> <strt> <condeqn> <ngwfnodes>
mawpackagedata = flopy.mf6.ModflowGwfmaw.packagedata.empty(gwf, maxbound=1)
mawpackagedata["radius"] = radius
mawpackagedata["bottom"] = maw_bot
mawpackagedata["strt"] = maw_strt
mawpackagedata["condeqn"] = "thiem"
mawpackagedata["ngwfnodes"] = 2

# <wellno> <icon> <cellid(ncelldim)> <scrn_top> <scrn_bot> <hk_skin> <radius_skin>
# <ifno> <icon> <cellid(ncelldim)> <scrn_top> <scrn_bot> <hk_skin> <radius_skin>
mawconnectiondata = flopy.mf6.ModflowGwfmaw.connectiondata.empty(
gwf, maxbound=2
)
Expand Down
4 changes: 2 additions & 2 deletions autotest/test_gwf_maw09.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,15 +147,15 @@ def build_model(idx, dir):
gwf, ss=0.0, sy=1.0, transient=True, iconvert=1
)

# <wellno> <radius> <bottom> <strt> <condeqn> <ngwfnodes>
# <ifno> <radius> <bottom> <strt> <condeqn> <ngwfnodes>
mawpackagedata = flopy.mf6.ModflowGwfmaw.packagedata.empty(gwf, maxbound=1)
mawpackagedata["radius"] = radius
mawpackagedata["bottom"] = maw_bot
mawpackagedata["strt"] = maw_strt
mawpackagedata["condeqn"] = "specified"
mawpackagedata["ngwfnodes"] = 2

# <wellno> <icon> <cellid(ncelldim)> <scrn_top> <scrn_bot> <hk_skin> <radius_skin>
# <ifno> <icon> <cellid(ncelldim)> <scrn_top> <scrn_bot> <hk_skin> <radius_skin>
mawconnectiondata = flopy.mf6.ModflowGwfmaw.connectiondata.empty(
gwf, maxbound=2
)
Expand Down
4 changes: 2 additions & 2 deletions autotest/test_gwt_mwt02.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ def build_model(idx, dir):

# MAW
opth = f"{name}.maw.obs"
# <wellno> <radius> <bottom> <strt> <condeqn> <ngwfnodes> [<aux(naux)>] [<boundname>]
# <ifno> <radius> <bottom> <strt> <condeqn> <ngwfnodes> [<aux(naux)>] [<boundname>]
wellbottom = 0.0
wellradius = 0.1
ngwfnodes = 1
Expand All @@ -130,7 +130,7 @@ def build_model(idx, dir):
[iwell, wellradius, wellbottom, strt, "THIEM", ngwfnodes, concwell]
for iwell in range(4)
]
# <wellno> <icon> <cellid(ncelldim)> <scrn_top> <scrn_bot> <hk_skin> <radius_skin>
# <ifno> <icon> <cellid(ncelldim)> <scrn_top> <scrn_bot> <hk_skin> <radius_skin>
wellconnectionsrecarray = [
[0, 0, (0, 15, 15), 10.0, 0.0, 10.0, 0.1],
[1, 0, (0, 15, 20), 10.0, 0.0, 10.0, 0.1],
Expand Down
22 changes: 11 additions & 11 deletions doc/Common/gwf-mawobs.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
MAW & head & wellno or boundname & -- & Head in a multi-aquifer well. If boundname is specified, boundname must be unique for each multi-aquifer well. \\
MAW & from-mvr & wellno or boundname & -- & Simulated inflow to a well from the MVR package for a multi-aquifer well or a group of multi-aquifer wells. \\
MAW & maw & wellno or boundname & \texttt{icon} or -- & Simulated flow rate for a multi-aquifer well or a group of multi-aquifer wells and its aquifer connection(s). If boundname is not specified for ID, then the simulated multi-aquifer well-aquifer flow rate at a specific multi-aquifer well connection is observed. In this case, ID2 must be specified and is the connection number \texttt{icon}. \\
MAW & rate & wellno or boundname & -- & Simulated pumping rate for a multi-aquifer well or a group of multi-aquifer wells. \\
MAW & rate-to-mvr & wellno or boundname & -- & Simulated well discharge that is available for the MVR package for a multi-aquifer well or a group of multi-aquifer wells. \\
MAW & fw-rate & wellno or boundname & -- & Simulated flowing well flow rate for a multi-aquifer well or a group of multi-aquifer wells. \\
MAW & fw-to-mvr & wellno or boundname & -- & Simulated flowing well discharge rate that is available for the MVR package for a multi-aquifer well or a group of multi-aquifer wells. \\
MAW & storage & wellno or boundname & -- & Simulated storage flow rate for a multi-aquifer well or a group of multi-aquifer wells. \\
MAW & constant & wellno or boundname & -- & Simulated constant-flow rate for a multi-aquifer well or a group of multi-aquifer wells. \\
MAW & conductance & wellno or boundname & \texttt{icon} or -- & Simulated well conductance for a multi-aquifer well or a group of multi-aquifer wells and its aquifer connection(s). If boundname is not specified for ID, then the simulated multi-aquifer well conductance at a specific multi-aquifer well connection is observed. In this case, ID2 must be specified and is the connection number \texttt{icon}. \\
MAW & fw-conductance & wellno or boundname & -- & Simulated flowing well conductance for a multi-aquifer well or a group of multi-aquifer wells.
MAW & head & ifno or boundname & -- & Head in a multi-aquifer well. If boundname is specified, boundname must be unique for each multi-aquifer well. \\
MAW & from-mvr & ifno or boundname & -- & Simulated inflow to a well from the MVR package for a multi-aquifer well or a group of multi-aquifer wells. \\
MAW & maw & ifno or boundname & \texttt{icon} or -- & Simulated flow rate for a multi-aquifer well or a group of multi-aquifer wells and its aquifer connection(s). If boundname is not specified for ID, then the simulated multi-aquifer well-aquifer flow rate at a specific multi-aquifer well connection is observed. In this case, ID2 must be specified and is the connection number \texttt{icon}. \\
MAW & rate & ifno or boundname & -- & Simulated pumping rate for a multi-aquifer well or a group of multi-aquifer wells. \\
MAW & rate-to-mvr & ifno or boundname & -- & Simulated well discharge that is available for the MVR package for a multi-aquifer well or a group of multi-aquifer wells. \\
MAW & fw-rate & ifno or boundname & -- & Simulated flowing well flow rate for a multi-aquifer well or a group of multi-aquifer wells. \\
MAW & fw-to-mvr & ifno or boundname & -- & Simulated flowing well discharge rate that is available for the MVR package for a multi-aquifer well or a group of multi-aquifer wells. \\
MAW & storage & ifno or boundname & -- & Simulated storage flow rate for a multi-aquifer well or a group of multi-aquifer wells. \\
MAW & constant & ifno or boundname & -- & Simulated constant-flow rate for a multi-aquifer well or a group of multi-aquifer wells. \\
MAW & conductance & ifno or boundname & \texttt{icon} or -- & Simulated well conductance for a multi-aquifer well or a group of multi-aquifer wells and its aquifer connection(s). If boundname is not specified for ID, then the simulated multi-aquifer well conductance at a specific multi-aquifer well connection is observed. In this case, ID2 must be specified and is the connection number \texttt{icon}. \\
MAW & fw-conductance & ifno or boundname & -- & Simulated flowing well conductance for a multi-aquifer well or a group of multi-aquifer wells.
14 changes: 7 additions & 7 deletions doc/Common/gwt-mwtobs.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
% general APT observations
MWT & concentration & mawno or boundname & -- & Well concentration. If boundname is specified, boundname must be unique for each well. \\
MWT & concentration & ifno or boundname & -- & Well concentration. If boundname is specified, boundname must be unique for each well. \\
%flowjaface not included
MWT & storage & mawno or boundname & -- & Simulated mass storage flow rate for a well or group of wells. \\
MWT & constant & mawno or boundname & -- & Simulated mass constant-flow rate for a well or group of wells. \\
MWT & from-mvr & mawno or boundname & -- & Simulated mass inflow into a well or group of wells from the MVT package. Mass inflow is calculated as the product of provider concentration and the mover flow rate. \\
MWT & mwt & mawno or boundname & \texttt{iconn} or -- & Mass flow rate for a well or group of wells and its aquifer connection(s). If boundname is not specified for ID, then the simulated well-aquifer flow rate at a specific well connection is observed. In this case, ID2 must be specified and is the connection number \texttt{iconn} for well \texttt{mawno}. \\
MWT & storage & ifno or boundname & -- & Simulated mass storage flow rate for a well or group of wells. \\
MWT & constant & ifno or boundname & -- & Simulated mass constant-flow rate for a well or group of wells. \\
MWT & from-mvr & ifno or boundname & -- & Simulated mass inflow into a well or group of wells from the MVT package. Mass inflow is calculated as the product of provider concentration and the mover flow rate. \\
MWT & mwt & ifno or boundname & \texttt{iconn} or -- & Mass flow rate for a well or group of wells and its aquifer connection(s). If boundname is not specified for ID, then the simulated well-aquifer flow rate at a specific well connection is observed. In this case, ID2 must be specified and is the connection number \texttt{iconn} for well \texttt{ifno}. \\

% observations specific to the mwt package
MWT & rate & mawno or boundname & -- & Simulated mass flow rate for a well or group of wells. \\
MWT & fw-rate & mawno or boundname & -- & Simulated mass flow rate for a flowing well or group of flowing wells. \\
MWT & rate & ifno or boundname & -- & Simulated mass flow rate for a well or group of wells. \\
MWT & fw-rate & ifno or boundname & -- & Simulated mass flow rate for a flowing well or group of flowing wells. \\
MWT & rate-to-mvr & well or boundname & -- & Simulated mass flow rate that is sent to the MVT Package for a well or group of wells.\\
MWT & fw-rate-to-mvr & well or boundname & -- & Simulated mass flow rate that is sent to the MVT Package from a flowing well or group of flowing wells. \\
22 changes: 11 additions & 11 deletions doc/mf6io/mf6ivar/dfn/gwf-maw.dfn
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,21 +334,21 @@ description integer value specifying the number of multi-aquifer wells that will

block packagedata
name packagedata
type recarray wellno radius bottom strt condeqn ngwfnodes aux boundname
type recarray ifno radius bottom strt condeqn ngwfnodes aux boundname
shape (nmawwells)
reader urword
longname
description

block packagedata
name wellno
name ifno
type integer
shape
tagged false
in_record true
reader urword
longname well number for this entry
description integer value that defines the well number associated with the specified PACKAGEDATA data on the line. WELLNO 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.
description integer value that defines the feature (well) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. Multi-aquifer well information must be specified for every multi-aquifer well or the program will terminate with an error. The program will also terminate with an error if information for a multi-aquifer well is specified more than once.
numeric_index true

block packagedata
Expand Down Expand Up @@ -399,7 +399,7 @@ tagged false
in_record true
reader urword
longname number of connected GWF cells
description integer value that defines the number of GWF nodes connected to this (WELLNO) multi-aquifer well. NGWFNODES must be greater than zero.
description integer value that defines the number of GWF nodes connected to this (IFNO) multi-aquifer well. NGWFNODES must be greater than zero.

block packagedata
name aux
Expand Down Expand Up @@ -429,20 +429,20 @@ description REPLACE boundname {'{#1}': 'multi-aquifer well'}

block connectiondata
name connectiondata
type recarray wellno icon cellid scrn_top scrn_bot hk_skin radius_skin
type recarray ifno icon cellid scrn_top scrn_bot hk_skin radius_skin
reader urword
longname
description

block connectiondata
name wellno
name ifno
type integer
shape
tagged false
in_record true
reader urword
longname well number for this entry
description integer value that defines the well number associated with the specified CONNECTIONDATA data on the line. WELLNO 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.
description integer value that defines the feature (well) number associated with the specified CONNECTIONDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. Multi-aquifer well connection information must be specified for every multi-aquifer well connection to the GWF model (NGWFNODES) or the program will terminate with an error. The program will also terminate with an error if connection information for a multi-aquifer well connection to the GWF model is specified more than once.
numeric_index true

block connectiondata
Expand All @@ -453,7 +453,7 @@ tagged false
in_record true
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 WELLNO.
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

block connectiondata
Expand Down Expand Up @@ -524,21 +524,21 @@ description REPLACE iper {}

block period
name perioddata
type recarray wellno mawsetting
type recarray ifno mawsetting
shape
reader urword
longname
description

block period
name wellno
name ifno
type integer
shape
tagged false
in_record true
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. WELLNO must be greater than zero and less than or equal to NMAWWELLS.
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

block period
Expand Down
12 changes: 6 additions & 6 deletions doc/mf6io/mf6ivar/dfn/gwt-mwt.dfn
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,21 +259,21 @@ description REPLACE obs6_filename {'{#1}': 'MWT'}

block packagedata
name packagedata
type recarray mawno strt aux boundname
type recarray ifno strt aux boundname
shape (maxbound)
reader urword
longname
description

block packagedata
name mawno
name ifno
type integer
shape
tagged false
in_record true
reader urword
longname well number for this entry
description integer value that defines the well number associated with the specified PACKAGEDATA data on the line. MAWNO must be greater than zero and less than or equal to NMAWWELLS. Well information must be specified for every well or the program will terminate with an error. The program will also terminate with an error if information for a well is specified more than once.
description integer value that defines the feature (well) number associated with the specified PACKAGEDATA data on the line. IFNO must be greater than zero and less than or equal to NMAWWELLS. Well information must be specified for every well or the program will terminate with an error. The program will also terminate with an error if information for a well is specified more than once.
numeric_index true

block packagedata
Expand Down Expand Up @@ -327,21 +327,21 @@ description REPLACE iper {}

block period
name mwtperioddata
type recarray mawno mwtsetting
type recarray ifno mwtsetting
shape
reader urword
longname
description

block period
name mawno
name ifno
type integer
shape
tagged false
in_record true
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.
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

block period
Expand Down
14 changes: 7 additions & 7 deletions doc/mf6io/mf6ivar/examples/gwf-maw-example1.dat
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ begin dimensions
end dimensions

begin packagedata
# wellno radius bottom strt condeqn ngwnodes name
1 0.15 -100.0 9.14 thiem 2 pwell
2 0.25 -100.0 9.14 thiem 1 iwell
# ifno radius bottom strt condeqn ngwnodes name
1 0.15 -100.0 9.14 thiem 2 pwell
2 0.25 -100.0 9.14 thiem 1 iwell
end packagedata

begin connectiondata
# wellno conn l r c stop sbot k rskin
1 1 1 51 51 0 0 0 0
1 2 2 51 51 0 0 0 0
2 1 2 2 2 0 0 0 0
# ifno conn l r c stop sbot k rskin
1 1 1 51 51 0 0 0 0
1 2 2 51 51 0 0 0 0
2 1 2 2 2 0 0 0 0
end connectiondata

begin period 1
Expand Down
Loading