consolidate ghb package code

Author: mjreno

autotest/test_gwf_disv_uzf.py

@@ -109,7 +109,7 @@
     uzf_spd.update({t: spd})
 
 
-# Work up the GHB / GHBA boundary
+# Work up the GHB / GHBG boundary
 ghb_ids = [(ncol - 1) + i * ncol for i in range(nrow)]
 ghb_spd = []
 abhead = np.full((nlay, ncpl), DNODATA, dtype=float)
@@ -173,7 +173,7 @@ def get_model(ws, name, array_input=False):
 
     # general-head boundary
     if array_input:
-        ghb = flopy.mf6.ModflowGwfghba(
+        ghb = flopy.mf6.ModflowGwfghbg(
             gwf, print_flows=True, maxbound=20, bhead=abhead, cond=acond
         )
     else:

autotest/test_gwf_sfr_inactive02.py

@@ -71,7 +71,7 @@ def get_model(ws, name, array_input=False):
         cond = np.full(nlay * nrow * ncol, DNODATA, dtype=float)
         bhead[0] = 1.0
         cond[0] = 1e6
-        flopy.mf6.ModflowGwfghba(gwf, maxbound=1, bhead=bhead, cond=cond)
+        flopy.mf6.ModflowGwfghbg(gwf, maxbound=1, bhead=bhead, cond=cond)
     else:
         flopy.mf6.ModflowGwfghb(gwf, stress_period_data=[((0, 0, 0), 1.0, 1e6)])
 

autotest/test_gwf_uzf01.py

@@ -98,14 +98,14 @@ def get_model(ws, name, array_input=False):
         transient={0: True},
     )
 
-    # ghb / ghba
+    # ghb / ghbg
     if array_input:
-        ghb_obs = {f"{name}.ghb.obs.csv": [("100_1_1", "GHBA", (99, 0, 0))]}
+        ghb_obs = {f"{name}.ghb.obs.csv": [("100_1_1", "GHB", (99, 0, 0))]}
         bhead = np.full(nlay * nrow * ncol, DNODATA, dtype=float)
         cond = np.full(nlay * nrow * ncol, DNODATA, dtype=float)
         bhead[nlay - 1] = 1.5
         cond[nlay - 1] = 1.0
-        ghb = flopy.mf6.ModflowGwfghba(
+        ghb = flopy.mf6.ModflowGwfghbg(
             gwf,
             print_input=True,
             print_flows=True,

autotest/test_gwf_vsc01.py

@@ -143,7 +143,7 @@ def get_model(idx, ws, array_input=False):
             bhead[0][0, i, ncol - 1] = top
             cond[0][0, i, ncol - 1] = ghbcond
             temp[0][0, i, ncol - 1] = initial_temperature
-        flopy.mf6.ModflowGwfghba(
+        flopy.mf6.ModflowGwfghbg(
             gwf,
             maxbound=nrow,
             pname="GHB-1",
@@ -269,10 +269,7 @@ def check_output(idx, ws, array_input=False):
     fname = os.path.join(ws, fname)
     assert os.path.isfile(fname)
     budobj = flopy.utils.CellBudgetFile(fname, precision="double")
-    if array_input:
-        outbud = budobj.get_data(text="            GHBA")
-    else:
-        outbud = budobj.get_data(text="             GHB")
+    outbud = budobj.get_data(text="             GHB")
 
     # Establish known answer:
     stored_ans = -151.63446156218242

autotest/test_gwt_henry_nr.py

@@ -219,9 +219,9 @@ def get_model(ws, name, array_input=False):
         auxiliary="CONCENTRATION",
     )
 
-    # ghb / ghba
+    # ghb / ghbg
     if array_input:
-        ghb1 = flopy.mf6.ModflowGwfghba(
+        ghb1 = flopy.mf6.ModflowGwfghbg(
             gwf,
             print_input=True,
             print_flows=True,

autotest/test_netcdf_gwf_disv_uzf.py

@@ -1,7 +1,7 @@
 """
 NetCDF test version of test_gwf_disv_uzf.  The primary aim is to test
-that GHBA package NetCDF array input (bhead and cond) gives the same
-results as test_gwf_disv_uzf list based (GHB) and array based (GHBA)
+that GHBG package NetCDF array input (bhead and cond) gives the same
+results as test_gwf_disv_uzf list based (GHB) and array based (GHBG)
 ascii input runs.  This test compares heads in the the NetCDF file to
 those in the FloPy binary output head file.
 """
@@ -35,7 +35,7 @@ def build_models(idx, test):
 
     sim, mc = build(idx, test)
     gwf = mc.gwf[0]
-    gwf.get_package("GHBA_0").export_array_netcdf = True
+    gwf.get_package("GHBG_0").export_array_netcdf = True
 
     name = cases[idx]
 
@@ -50,7 +50,7 @@ def check_output(idx, test):
     name = test.name
     ws = Path(test.workspace / "mf6")
 
-    # check outputs of GHB / GHBA ascii input runs
+    # check outputs of GHB / GHBG ascii input runs
     check(test.workspace, name)
     check(ws, name)
 
@@ -77,14 +77,15 @@ def check_output(idx, test):
         f.write(f"  IC6  {name}.ic  ic\n")
         f.write(f"  NPF6  {name}.npf  npf\n")
         f.write(f"  STO6  {name}.sto  sto\n")
-        f.write(f"  GHBA6  {name}.ghba  ghba_0\n")
+        f.write(f"  GHB6  {name}.ghbg  ghbg_0\n")
         f.write(f"  UZF6  {name}.uzf  uzf_0\n")
         f.write(f"  OC6  {name}.oc  oc\n")
         f.write(f"  OBS6  {name}.obs  head_obs\n")
         f.write("END packages\n")
 
-    with open(ws / f"{name}.ghba", "w") as f:
+    with open(ws / f"{name}.ghbg", "w") as f:
         f.write("BEGIN options\n")
+        f.write("  READARRAYGRID\n")
         f.write("  PRINT_INPUT\n")
         f.write("  PRINT_FLOWS\n")
         f.write("END options\n\n")

autotest/test_netcdf_gwf_uzf01.py

@@ -1,7 +1,7 @@
 """
 NetCDF test version of test_gwf_uzf01.  The primary aim is to test
-that GHBA package NetCDF array input (bhead and cond) gives the same
-results as test_gwf_uzf01 list based (GHB) and array based (GHBA)
+that GHBG package NetCDF array input (bhead and cond) gives the same
+results as test_gwf_uzf01 list based (GHB) and array based (GHBG)
 ascii input runs.  This test compares heads in the the NetCDF file
 to those in the FloPy binary output head file.
 """
@@ -37,8 +37,8 @@ def build_models(idx, test, export):
 
     sim, mc = build(idx, test)
     gwf = mc.gwf[0]
-    ghba = gwf.get_package("GHBA_0")
-    ghba.export_array_netcdf = True
+    ghbg = gwf.get_package("GHBG_0")
+    ghbg.export_array_netcdf = True
 
     if export == "ugrid":
         gwf.name_file.nc_mesh2d_filerecord = f"{name}.nc"
@@ -54,7 +54,7 @@ def check_output(idx, test, export):
     name = test.name
     ws = Path(test.workspace / "mf6")
 
-    # check outputs of GHB / GHBA ascii input runs
+    # check outputs of GHB / GHBG ascii input runs
     check(test.workspace, name)
     check(ws, name)
 
@@ -84,14 +84,15 @@ def check_output(idx, test, export):
         f.write(f"  IC6  {name}.ic  ic\n")
         f.write(f"  NPF6  {name}.npf  npf\n")
         f.write(f"  STO6  {name}.sto  sto\n")
-        f.write(f"  GHBA6  {name}.ghba  ghba_0\n")
+        f.write(f"  GHB6  {name}.ghbg  ghbg_0\n")
         f.write(f"  UZF6  {name}.uzf  uzf_0\n")
         f.write(f"  OC6  {name}.oc  oc\n")
         f.write(f"  OBS6  {name}.obs  head_obs\n")
         f.write("END packages\n")
 
-    with open(ws / f"{name}.ghba", "w") as f:
+    with open(ws / f"{name}.ghbg", "w") as f:
         f.write("BEGIN options\n")
+        f.write("  READARRAYGRID\n")
         f.write("  PRINT_INPUT\n")
         f.write("  PRINT_FLOWS\n")
         f.write("  OBS6  FILEIN  gwf_uzf01a.ghb.obs\n")

autotest/test_netcdf_gwf_vsc01.py

@@ -1,8 +1,8 @@
 """
 NetCDF test version of test_gwf_vsc01.  The primary aim is to test
-that GHBA package NetCDF array input (bhead, cond, and temperature
+that GHBG package NetCDF array input (bhead, cond, and temperature
 auxiliary arrays) gives the same results as test_gwf_vsc01 list based
-(GHB) and array based (GHBA) ascii input runs.  This test compares
+(GHB) and array based (GHBG) ascii input runs.  This test compares
 heads in the the NetCDF file to those in the FloPy binary output
 head file.
 """
@@ -55,7 +55,7 @@ def check_output(idx, test, export):
     name = "gwf-" + test.name
     ws = Path(test.workspace / "mf6")
 
-    # check outputs of GHB / GHBA ascii input runs
+    # check outputs of GHB / GHBG ascii input runs
     check(idx, test.workspace, array_input=False)
     check(idx, ws, array_input=True)
 
@@ -85,13 +85,14 @@ def check_output(idx, test, export):
         f.write(f"  IC6  {name}.ic  ic\n")
         if viscosity_on[idx]:
             f.write(f"  VSC6  {name}.vsc  vsc\n")
-        f.write(f"  GHBA6  {name}.ghba  ghb-1\n")
+        f.write(f"  GHB6  {name}.ghbg ghb-1\n")
         f.write(f"  CHD6  {name}.chd  chd-1\n")
         f.write(f"  OC6  {name}.oc  oc\n")
         f.write("END packages\n")
 
-    with open(ws / f"{name}.ghba", "w") as f:
+    with open(ws / f"{name}.ghbg", "w") as f:
         f.write("BEGIN options\n")
+        f.write("  READARRAYGRID\n")
         f.write("  auxiliary  TEMPERATURE\n")
         f.write("END options\n\n")
         f.write("BEGIN dimensions\n")

autotest/test_netcdf_gwt_henry_nr.py

@@ -1,8 +1,8 @@
 """
 NetCDF test version of test_gwt_henry_nr.  The primary aim is to test
-that GHBA package NetCDF array input (bhead, cond, concentration and
+that GHBG package NetCDF array input (bhead, cond, concentration and
 density auxiliary arrays) gives the same results as test_gwt_henry_nr
-list based (GHB) and array based (GHBA) ascii input runs.  This test
+list based (GHB) and array based (GHBG) ascii input runs.  This test
 compares heads in the the NetCDF file to those in the FloPy binary
 output head file.
 """
@@ -54,14 +54,14 @@ def check_output(idx, test, export):
     from test_gwt_henry_nr import check_output as check
 
     name = "gwf_" + test.name
-    ghba_ws = Path(test.workspace / "mf6")
+    ghbg_ws = Path(test.workspace / "mf6")
     ws = Path(test.workspace / "mf6" / "netcdf")
-    shutil.copytree(ghba_ws, ws)
+    shutil.copytree(ghbg_ws, ws)
 
-    # check outputs of GHB / GHBA ascii input runs
+    # check outputs of GHB / GHBG ascii input runs
     check(test.workspace, test.name, test.sims[0])
     # check(ws, test.name, test.sims[0])
-    check(ghba_ws, test.name, test.sims[0])
+    check(ghbg_ws, test.name, test.sims[0])
 
     # verify format of generated netcdf file
     with nc.Dataset(ws / f"{name}.nc") as ds:
@@ -90,13 +90,14 @@ def check_output(idx, test, export):
         f.write(f"  STO6  {name}.sto  sto\n")
         f.write(f"  BUY6  {name}.buy  buy\n")
         f.write(f"  DRN6  {name}.drn  drn-1\n")
-        f.write(f"  GHBA6  {name}.ghba  ghb-1\n")
+        f.write(f"  GHB6  {name}.ghbg  ghb-1\n")
         f.write(f"  WEL6  {name}.wel  wel-1\n")
         f.write(f"  OC6  {name}.oc  oc\n")
         f.write("END packages\n")
 
-    with open(ws / f"{name}.ghba", "w") as f:
+    with open(ws / f"{name}.ghbg", "w") as f:
         f.write("BEGIN options\n")
+        f.write("  READARRAYGRID\n")
         f.write("  auxiliary  CONCENTRATION  DENSITY\n")
         f.write("  PRINT_INPUT\n")
         f.write("  PRINT_FLOWS\n")
@@ -132,7 +133,7 @@ def check_output(idx, test, export):
     names = [name, "gwt_" + test.name]
     for i, e in enumerate(ext):
         fpth1 = os.path.join(
-            ghba_ws,
+            ghbg_ws,
             f"{names[i]}.{e}",
         )
         fpth2 = os.path.join(ws, f"{names[i]}.{e}")

doc/mf6io/mf6ivar/dfn/gwf-ghba.dfn renamed to doc/mf6io/mf6ivar/dfn/gwf-ghbg.dfn

@@ -1,7 +1,16 @@
-# --------------------- gwf ghba options ---------------------
+# --------------------- gwf ghbg options ---------------------
 # flopy multi-package
 # package-type stress-package
 
+block options
+name readarraygrid
+type keyword
+reader urword
+optional false
+longname use array-based grid input
+description indicates that array-based grid input will be used for the general-head boundary package.  This keyword must be specified to use array-based grid input.  When READARRAYGRID is specified, values must be provided for every cell within a model grid, even those cells that have an IDOMAIN value less than one.  Values assigned to cells with IDOMAIN values less than one are not used and have no effect on simulation results. No data cells should contain the value DNODATA (3.0E+30). 
+default_value True
+
 block options
 name auxiliary
 type string
@@ -43,7 +52,7 @@ name save_flows
 type keyword
 reader urword
 optional true
-longname save GHBA flows to budget file
+longname save GHBG flows to budget file
 description REPLACE save_flows {'{#1}': 'general-head boundary'}
 mf6internal ipakcb
 
@@ -109,7 +118,7 @@ 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
 
-# --------------------- gwf ghba dimensions ---------------------
+# --------------------- gwf ghbg dimensions ---------------------
 
 block dimensions
 name maxbound
@@ -119,7 +128,7 @@ optional false
 longname maximum number of general-head boundaries in any stress period
 description REPLACE maxbound {'{#1}': 'general-head boundary'}
 
-# --------------------- gwf ghba period ---------------------
+# --------------------- gwf ghbg period ---------------------
 
 block period
 name iper