add basic MFArray tests

docs/examples/array_example.py

@@ -49,7 +49,7 @@
 # Open and load a NumPy array representation
 
 fhandle = open(internal)
-imfa = MFArray.load(fhandle, data_path, shape)
+imfa = MFArray.load(fhandle, data_path, shape, header=False)
 
 # Get values
 
@@ -70,7 +70,7 @@
 plt.colorbar()
 
 fhandle = open(constant)
-cmfa = MFArray.load(fhandle, data_path, shape)
+cmfa = MFArray.load(fhandle, data_path, shape, header=False)
 cvals = cmfa.value
 plt.imshow(cvals[0:100])
 plt.colorbar()
@@ -93,7 +93,7 @@
 # External
 
 fhandle = open(external)
-emfa = MFArray.load(fhandle, data_path, shape)
+emfa = MFArray.load(fhandle, data_path, shape, header=False)
 evals = emfa.value
 evals
 
@@ -118,7 +118,7 @@
 
 fhandle = open(ilayered)
 shape = (3, 1000, 100)
-ilmfa = MFArray.load(fhandle, data_path, shape, layered=True)
+ilmfa = MFArray.load(fhandle, data_path, shape, header=False, layered=True)
 vals = ilmfa.value
 
 ilmfa._value  # internal storage
@@ -165,7 +165,7 @@
 
 fhandle = open(clayered)
 shape = (3, 1000, 100)
-clmfa = MFArray.load(fhandle, data_path, shape, layered=True)
+clmfa = MFArray.load(fhandle, data_path, shape, header=False, layered=True)
 
 clmfa._value
 
@@ -218,7 +218,7 @@
 
 fhandle = open(mlayered)
 shape = (3, 1000, 100)
-mlmfa = MFArray.load(fhandle, data_path, shape, layered=True)
+mlmfa = MFArray.load(fhandle, data_path, shape, header=False, layered=True)
 
 mlmfa.how
 

flopy4/array.py

@@ -183,8 +183,8 @@ class MFArray(MFParameter, NumPyArrayMixin):
 
     def __init__(
         self,
-        array,
         shape,
+        array=None,
         how=MFArrayType.internal,
         factor=None,
         block=None,
@@ -328,53 +328,42 @@ def write(self, f):
         pass
 
     @classmethod
-    def load(cls, f, cwd, shape, layered=False):
-        """
-
-        Parameters
-        ----------
-        f
+    def load(cls, f, cwd, shape, header=True, **kwargs):
+        layered = kwargs.pop("layered", False)
+
+        if header:
+            tokens = multi_line_strip(f).split()
+            name = tokens[0]
+            kwargs.pop("name", None)
+            if len(tokens) > 1 and tokens[1] == "layered":
+                layered = True
+        else:
+            name = kwargs.pop("name", None)
 
-        Returns
-        -------
-            MFArray
-        """
         if layered:
             nlay = shape[0]
-            lay_shape = shape[1:]
+            lshp = shape[1:]
             objs = []
             for _ in range(nlay):
-                mfa = cls._load(f, cwd, lay_shape)
+                mfa = cls._load(f, cwd, lshp, name)
                 objs.append(mfa)
 
-            mfa = MFArray(
-                np.array(objs, dtype=object),
+            return MFArray(
                 shape,
+                array=np.array(objs, dtype=object),
                 how=None,
                 factor=None,
+                name=name,
                 layered=True,
             )
-
         else:
-            mfa = cls._load(f, cwd, shape, layered=layered)
-
-        return mfa
+            kwargs.pop("layered", None)
+            return cls._load(
+                f, cwd, shape, layered=layered, name=name, **kwargs
+            )
 
     @classmethod
-    def _load(cls, f, cwd, shape, layered=False):
-        """
-
-        Parameters
-        ----------
-        f
-        cwd
-        shape
-        layered
-
-        Returns
-        -------
-
-        """
+    def _load(cls, f, cwd, shape, layered=False, **kwargs):
         control_line = multi_line_strip(f).split()
 
         if CommonNames.iprn.lower() in control_line:
@@ -392,7 +381,7 @@ def _load(cls, f, cwd, shape, layered=False):
             array = float(control_line[clpos])
             clpos += 1
 
-        elif how == how.external:
+        elif how == MFArrayType.external:
             ext_path = Path(control_line[clpos])
             fpath = cwd / ext_path
             with open(fpath) as foo:
@@ -406,8 +395,7 @@ def _load(cls, f, cwd, shape, layered=False):
         if len(control_line) > 2:
             factor = float(control_line[clpos + 1])
 
-        mfa = cls(array, shape, how, factor=factor)
-        return mfa
+        return cls(shape, array=array, how=how, factor=factor, **kwargs)
 
     @staticmethod
     def read_array(f):
@@ -433,6 +421,7 @@ def read_array(f):
                 CommonNames.internal in line
                 or CommonNames.external in line
                 or CommonNames.constant in line
+                or CommonNames.end in line.upper()
             ):
                 f.seek(pos, 0)
                 break

flopy4/block.py

@@ -3,6 +3,7 @@
 from dataclasses import asdict
 from typing import Any
 
+from flopy4.array import MFArray
 from flopy4.parameter import MFParameter, MFParameters
 from flopy4.utils import strip
 
@@ -30,6 +31,21 @@ class MFBlockMappingMeta(MFBlockMeta, ABCMeta):
 
 
 class MFBlock(MFParameters, metaclass=MFBlockMappingMeta):
+    """
+    MF6 input block. Maps parameter names to parameters.
+
+    Notes
+    -----
+    This class is dynamically subclassed by `MFPackage`
+    to match each block within a package parameter set.
+
+    Supports dictionary and attribute access. The class
+    attributes specify the block's parameters. Instance
+    attributes contain both the specification and value.
+
+    The block's name and index are discovered upon load.
+    """
+
     def __init__(self, name=None, index=None, params=None):
         self.name = name
         self.index = index
@@ -49,7 +65,7 @@ def params(self) -> MFParameters:
         return self.data
 
     @classmethod
-    def load(cls, f):
+    def load(cls, f, **kwargs):
         name = None
         index = None
         found = False
@@ -72,9 +88,13 @@ def load(cls, f):
                 param = members.get(key)
                 if param is not None:
                     f.seek(pos)
-                    params[key] = type(param).load(
-                        f, **asdict(param.with_name(key).with_block(name))
-                    )
+                    spec = asdict(param.with_name(key).with_block(name))
+                    kwargs = {**kwargs, **spec}
+                    if type(param) is MFArray:
+                        # TODO: inject from model somehow?
+                        # and remove special handling here
+                        kwargs["cwd"] = ""
+                    params[key] = type(param).load(f, **kwargs)
 
         return cls(name, index, params)
 

flopy4/constants.py

@@ -8,3 +8,4 @@ class CommonNames:
     vertex = "vertex"
     unstructured = "unstructured"
     empty = ""
+    end = "END"

flopy4/package.py

@@ -51,7 +51,8 @@ class MFPackageMappingMeta(MFPackageMeta, ABCMeta):
 
 class MFPackage(UserDict, metaclass=MFPackageMappingMeta):
     """
-    MF6 package base class.
+    MF6 model or simulation component package.
+
 
     TODO: reimplement with `ChainMap`?
     """
@@ -93,6 +94,8 @@ def load(cls, f):
             line = f.readline()
             if line == "":
                 break
+            if line == "\n":
+                continue
             line = strip(line).lower()
             words = line.split()
             key = words[0]

flopy4/parameter.py

@@ -1,8 +1,9 @@
 from abc import abstractmethod
+from ast import literal_eval
 from collections import UserDict
 from dataclasses import dataclass, fields
 from enum import Enum
-from typing import Any, Optional
+from typing import Any, Optional, Tuple
 
 
 class MFReader(Enum):
@@ -40,6 +41,7 @@ class MFParamSpec:
     repeating: bool = False
     tagged: bool = True
     reader: MFReader = MFReader.urword
+    shape: Optional[Tuple[int]] = None
     default_value: Optional[Any] = None
 
     @classmethod
@@ -74,6 +76,8 @@ def load(cls, f) -> "MFParamSpec":
                 spec[key] = val == "true"
             elif key == "reader":
                 spec[key] = MFReader.from_str(val)
+            elif key == "shape":
+                spec[key] = literal_eval(val)
             else:
                 spec[key] = val
         return cls(**spec)
@@ -134,6 +138,7 @@ def __init__(
         repeating=False,
         tagged=False,
         reader=MFReader.urword,
+        shape=None,
         default_value=None,
     ):
         super().__init__(
@@ -150,6 +155,7 @@ def __init__(
             repeating=repeating,
             tagged=tagged,
             reader=reader,
+            shape=shape,
             default_value=default_value,
         )
 
@@ -161,7 +167,10 @@ def value(self) -> Optional[Any]:
 
 
 class MFParameters(UserDict):
-    """Mapping of parameter names to parameters."""
+    """
+    Mapping of parameter names to parameters.
+    Supports dictionary and attribute access.
+    """
 
     def __init__(self, params=None):
         super().__init__(params)

flopy4/scalar.py

@@ -26,6 +26,7 @@ def __init__(
         repeating=False,
         tagged=False,
         reader=MFReader.urword,
+        shape=None,
         default_value=None,
     ):
         self._value = value
@@ -43,6 +44,7 @@ def __init__(
             repeating,
             tagged,
             reader,
+            shape,
             default_value,
         )
 
@@ -68,6 +70,7 @@ def __init__(
         repeating=False,
         tagged=False,
         reader=MFReader.urword,
+        shape=None,
         default_value=None,
     ):
         super().__init__(
@@ -85,6 +88,7 @@ def __init__(
             repeating,
             tagged,
             reader,
+            shape,
             default_value,
         )
 
@@ -122,6 +126,7 @@ def __init__(
         repeating=False,
         tagged=False,
         reader=MFReader.urword,
+        shape=None,
         default_value=None,
     ):
         super().__init__(
@@ -139,6 +144,7 @@ def __init__(
             repeating,
             tagged,
             reader,
+            shape,
             default_value,
         )
 
@@ -174,6 +180,7 @@ def __init__(
         repeating=False,
         tagged=False,
         reader=MFReader.urword,
+        shape=None,
         default_value=None,
     ):
         super().__init__(
@@ -191,6 +198,7 @@ def __init__(
             repeating,
             tagged,
             reader,
+            shape,
             default_value,
         )
 
@@ -226,6 +234,7 @@ def __init__(
         repeating=False,
         tagged=False,
         reader=MFReader.urword,
+        shape=None,
         default_value=None,
     ):
         super().__init__(
@@ -243,6 +252,7 @@ def __init__(
             repeating,
             tagged,
             reader,
+            shape,
             default_value,
         )
 
@@ -290,6 +300,7 @@ def __init__(
         repeating=False,
         tagged=False,
         reader=MFReader.urword,
+        shape=None,
         default_value=None,
     ):
         self.inout = inout
@@ -308,6 +319,7 @@ def __init__(
             repeating,
             tagged,
             reader,
+            shape,
             default_value,
         )