Merge pull request #9 from mjreno/test_input_pkg

Add modflow 6 input tests for ic, dis

flopy4/array.py

@@ -1,3 +1,4 @@
+import re
 from enum import Enum
 from io import StringIO
 from pathlib import Path
@@ -205,6 +206,7 @@ def __init__(
     ):
         MFParam.__init__(
             self,
+            shape=shape,
             block=block,
             name=name,
             type=type,
@@ -423,20 +425,7 @@ def read_array(f):
             pos = f.tell()
             line = f.readline()
             line = line_strip(line)
-            if line in (
-                CommonNames.empty,
-                CommonNames.internal,
-                CommonNames.external,
-                CommonNames.constant,
-            ):
-                f.seek(pos, 0)
-                break
-            elif (
-                CommonNames.internal in line
-                or CommonNames.external in line
-                or CommonNames.constant in line
-                or CommonNames.end in line.upper()
-            ):
+            if not re.match("^[0-9. ]+$", line):
                 f.seek(pos, 0)
                 break
             astr.append(line)

flopy4/block.py

@@ -22,7 +22,10 @@ def get_param(members, key, block):
         param = ks[0]
     else:
         param = members.get(key)
-        param.name = key
+        if param is not None:
+            param.name = key
+        else:
+            raise ValueError(f"Invalid parameter: {key.upper()}")
     param.block = block
     return param
 

spec/dfn/gwf-ic.dfn

@@ -0,0 +1,31 @@
+# --------------------- gwf ic options ---------------------
+
+block options
+name export_array_ascii
+type keyword
+reader urword
+optional true
+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.
+
+# --------------------- gwf ic griddata ---------------------
+
+block griddata
+name strt
+type double precision
+shape (nodes)
+reader readarray
+layered true
+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.
+default_value 1.0

spec/dfn2toml.py

@@ -85,7 +85,7 @@ def __init__(
                 d["block"][b][name] = block_d[p]
 
         if self._multi_package:
-            d["multipkg"] = True
+            d["multi"] = True
         if self._stress_package:
             d["stress"] = True
         if self._advanced_package:
@@ -201,40 +201,9 @@ def _substitute(self, blockname, component, subcomponent):
             if "block_variable" in v and v["block_variable"].upper() == "TRUE":
                 continue
 
-            vtype = v["type"].upper()
-            if vtype == "DOUBLE PRECISION":
-                vtype = "DOUBLE"
-            recarray = vtype and vtype.startswith("RECARRAY")
-
-            vname = v["name"].upper()
-
-            shape = ""
-            shapelist = []
-            if "shape" in v:
-                shape = v["shape"]
-                shape = shape.replace("(", "")
-                shape = shape.replace(")", "")
-                shape = shape.replace(",", "")
-                shape = shape.upper()
-                if shape == "NCOL*NROW; NCPL":
-                    if (
-                        vname == "AUX"
-                        and "reader" in v
-                        and v["reader"] == "readarray"
-                    ):
-                        shape = "NAUX NCPL"
-                    else:
-                        shape = "NCPL"
-                shapelist = shape.strip().split()
-
-            ndim = len(shapelist)
-            if (
-                shape != ""
-                and ndim > 0
-                and not recarray
-                and (vtype == "DOUBLE" or vtype == "INTEGER")
-            ):
-                vtype = f"{vtype}{ndim}D"
+            vtype = v["type"].lower()
+            if vtype == "double precision":
+                vtype = "double"
 
             d = None
             d = mf6_param_dfn.copy()
@@ -249,8 +218,6 @@ def _substitute(self, blockname, component, subcomponent):
                         valid = v[k].strip().split()
                         if len(valid) > 0:
                             d[k] = valid.copy()
-                    elif k == "shape":
-                        d[k] = shape
                     elif k == "type":
                         d[k] = vtype
                     else:

spec/dfns.txt

@@ -6,6 +6,7 @@
 
 # gwf model
 gwf-dis.dfn
+gwf-ic.dfn
 
 # gwt model
 gwt-dis.dfn

spec/toml/gwe-dis.toml

@@ -6,7 +6,7 @@ stress = false
 advanced = false
 
 [block.options.length_units]
-type = "STRING"
+type = "string"
 block_variable = false
 valid = []
 shape = ""
@@ -23,7 +23,7 @@ description = "is the length units used for this model.  Values can be ``FEET'',
 deprecated = ""
 
 [block.options.nogrb]
-type = "KEYWORD"
+type = "keyword"
 block_variable = false
 valid = []
 shape = ""
@@ -40,7 +40,7 @@ description = "keyword to deactivate writing of the binary grid file."
 deprecated = ""
 
 [block.options.xorigin]
-type = "DOUBLE"
+type = "double"
 block_variable = false
 valid = []
 shape = ""
@@ -57,7 +57,7 @@ description = "x-position of the lower-left corner of the model grid.  A default
 deprecated = ""
 
 [block.options.yorigin]
-type = "DOUBLE"
+type = "double"
 block_variable = false
 valid = []
 shape = ""
@@ -74,7 +74,7 @@ description = "y-position of the lower-left corner of the model grid.  If not sp
 deprecated = ""
 
 [block.options.angrot]
-type = "DOUBLE"
+type = "double"
 block_variable = false
 valid = []
 shape = ""
@@ -91,7 +91,7 @@ description = "counter-clockwise rotation angle (in degrees) of the lower-left c
 deprecated = ""
 
 [block.options.export_array_ascii]
-type = "KEYWORD"
+type = "keyword"
 block_variable = false
 valid = []
 shape = ""
@@ -108,7 +108,7 @@ description = "keyword that specifies input griddata arrays should be written to
 deprecated = ""
 
 [block.options.export_array_netcdf]
-type = "KEYWORD"
+type = "keyword"
 block_variable = false
 valid = []
 shape = ""
@@ -125,7 +125,7 @@ description = "keyword that specifies input griddata arrays should be written to
 deprecated = ""
 
 [block.options.ncf_filerecord]
-type = "RECORD NCF6 FILEIN NCF6_FILENAME"
+type = "record ncf6 filein ncf6_filename"
 block_variable = false
 valid = []
 shape = ""
@@ -142,7 +142,7 @@ description = ""
 deprecated = ""
 
 [block.options.ncf6]
-type = "KEYWORD"
+type = "keyword"
 block_variable = false
 valid = []
 shape = ""
@@ -159,7 +159,7 @@ description = "keyword to specify that record corresponds to a netcdf configurat
 deprecated = ""
 
 [block.options.filein]
-type = "KEYWORD"
+type = "keyword"
 block_variable = false
 valid = []
 shape = ""
@@ -176,7 +176,7 @@ description = "keyword to specify that an input filename is expected next."
 deprecated = ""
 
 [block.options.ncf6_filename]
-type = "STRING"
+type = "string"
 block_variable = false
 valid = []
 shape = ""
@@ -193,7 +193,7 @@ description = "defines a netcdf configuration (NCF) input file."
 deprecated = ""
 
 [block.dimensions.nlay]
-type = "INTEGER"
+type = "integer"
 block_variable = false
 valid = []
 shape = ""
@@ -211,7 +211,7 @@ description = "is the number of layers in the model grid."
 deprecated = ""
 
 [block.dimensions.nrow]
-type = "INTEGER"
+type = "integer"
 block_variable = false
 valid = []
 shape = ""
@@ -229,7 +229,7 @@ description = "is the number of rows in the model grid."
 deprecated = ""
 
 [block.dimensions.ncol]
-type = "INTEGER"
+type = "integer"
 block_variable = false
 valid = []
 shape = ""
@@ -247,10 +247,10 @@ description = "is the number of columns in the model grid."
 deprecated = ""
 
 [block.griddata.delr]
-type = "DOUBLE1D"
+type = "double"
 block_variable = false
 valid = []
-shape = "NCOL"
+shape = "(ncol)"
 tagged = true
 in_record = false
 layered = false
@@ -265,10 +265,10 @@ description = "is the column spacing in the row direction."
 deprecated = ""
 
 [block.griddata.delc]
-type = "DOUBLE1D"
+type = "double"
 block_variable = false
 valid = []
-shape = "NROW"
+shape = "(nrow)"
 tagged = true
 in_record = false
 layered = false
@@ -283,10 +283,10 @@ description = "is the row spacing in the column direction."
 deprecated = ""
 
 [block.griddata.top]
-type = "DOUBLE2D"
+type = "double"
 block_variable = false
 valid = []
-shape = "NCOL NROW"
+shape = "(ncol, nrow)"
 tagged = true
 in_record = false
 layered = false
@@ -301,10 +301,10 @@ description = "is the top elevation for each cell in the top model layer."
 deprecated = ""
 
 [block.griddata.botm]
-type = "DOUBLE3D"
+type = "double"
 block_variable = false
 valid = []
-shape = "NCOL NROW NLAY"
+shape = "(ncol, nrow, nlay)"
 tagged = true
 in_record = false
 layered = true
@@ -319,10 +319,10 @@ description = "is the bottom elevation for each cell."
 deprecated = ""
 
 [block.griddata.idomain]
-type = "INTEGER3D"
+type = "integer"
 block_variable = false
 valid = []
-shape = "NCOL NROW NLAY"
+shape = "(ncol, nrow, nlay)"
 tagged = true
 in_record = false
 layered = true