Modified flopy/modflow/ load methods to allow better subclassing.

flopy/modflow/mf.py

@@ -670,8 +670,9 @@ def load_results(self, **kwargs):
         else:
             return hdObj, ddObj, bdObj
 
-    @staticmethod
+    @classmethod
     def load(
+        cls,
         f,
         version="mf2005",
         exe_name="mf2005.exe",
@@ -746,7 +747,7 @@ def load(
             os.path.join(model_ws, f)
         )
 
-        ml = Modflow(
+        ml = cls(
             modelname,
             version=version,
             exe_name=exe_name,

flopy/modflow/mfag.py

@@ -685,8 +685,8 @@ def get_default_dtype(maxells=0, block="well"):
 
         return np.dtype(dtype)
 
-    @staticmethod
-    def load(f, model, nper=0, ext_unit_dict=None):
+    @classmethod
+    def load(cls, f, model, nper=0, ext_unit_dict=None):
         """
         Method to load the AG package from file
 
@@ -891,7 +891,7 @@ def load(f, model, nper=0, ext_unit_dict=None):
                         "Something went wrong at: {}".format(line)
                     )
 
-        return ModflowAg(
+        return cls(
             model,
             options=options,
             time_series=time_series,

flopy/modflow/mfbas.py

@@ -286,8 +286,8 @@ def write_file(self, check=True):
         # Close file
         f_bas.close()
 
-    @staticmethod
-    def load(f, model, ext_unit_dict=None, check=True, **kwargs):
+    @classmethod
+    def load(cls, f, model, ext_unit_dict=None, check=True, **kwargs):
         """
         Load an existing package.
 
@@ -398,7 +398,7 @@ def load(f, model, ext_unit_dict=None, check=True, **kwargs):
             )
 
         # create bas object and return
-        bas = ModflowBas(
+        bas = cls(
             model,
             ibound=ibound,
             strt=strt,

flopy/modflow/mfbcf.py

@@ -320,8 +320,8 @@ def write_file(self, f=None):
                 f_bcf.write(self.wetdry[k].get_file_entry())
         f_bcf.close()
 
-    @staticmethod
-    def load(f, model, ext_unit_dict=None):
+    @classmethod
+    def load(cls, f, model, ext_unit_dict=None):
         """
         Load an existing package.
 
@@ -529,7 +529,7 @@ def load(f, model, ext_unit_dict=None):
                 model.add_pop_key_list(ipakcb)
 
         # create instance of bcf object
-        bcf = ModflowBcf(
+        bcf = cls(
             model,
             ipakcb=ipakcb,
             intercellt=intercellt,

flopy/modflow/mfde4.py

@@ -227,8 +227,8 @@ def write_file(self):
             f.write("\n")
         f.close()
 
-    @staticmethod
-    def load(f, model, ext_unit_dict=None):
+    @classmethod
+    def load(cls, f, model, ext_unit_dict=None):
         """
         Load an existing package.
 
@@ -313,7 +313,7 @@ def load(f, model, ext_unit_dict=None):
                 ext_unit_dict, filetype=ModflowDe4.ftype()
             )
 
-        de4 = ModflowDe4(
+        de4 = cls(
             model,
             itmx=itmx,
             mxup=mxup,

flopy/modflow/mfdis.py

@@ -848,8 +848,8 @@ def check(self, f=None, verbose=True, level=1, checktype=None):
         # if verbose:
         #     print(txt)
 
-    @staticmethod
-    def load(f, model, ext_unit_dict=None, check=True):
+    @classmethod
+    def load(cls, f, model, ext_unit_dict=None, check=True):
         """
         Load an existing package.
 
@@ -1067,7 +1067,7 @@ def load(f, model, ext_unit_dict=None, check=True):
             )
 
         # create dis object instance
-        dis = ModflowDis(
+        dis = cls(
             model,
             nlay=nlay,
             nrow=nrow,

flopy/modflow/mfdisu.py

@@ -529,8 +529,8 @@ def zcentroids(self):
     def ncpl(self):
         return self.nodes / self.nlay
 
-    @staticmethod
-    def load(f, model, ext_unit_dict=None, check=False):
+    @classmethod
+    def load(cls, f, model, ext_unit_dict=None, check=False):
         """
         Load an existing package.
 
@@ -798,7 +798,7 @@ def load(f, model, ext_unit_dict=None, check=False):
             )
 
         # create dis object instance
-        disu = ModflowDisU(
+        disu = cls(
             model,
             nodes=nodes,
             nlay=nlay,

flopy/modflow/mfevt.py

@@ -215,8 +215,8 @@ def write_file(self, f=None):
                 f_evt.write(ievt)
         f_evt.close()
 
-    @staticmethod
-    def load(f, model, nper=None, ext_unit_dict=None):
+    @classmethod
+    def load(cls, f, model, nper=None, ext_unit_dict=None):
         """
         Load an existing package.
 
@@ -417,7 +417,7 @@ def load(f, model, nper=None, ext_unit_dict=None):
         args["unitnumber"] = unitnumber
         args["filenames"] = filenames
 
-        evt = ModflowEvt(model, **args)
+        evt = cls(model, **args)
 
         # return evt object
         return evt

flopy/modflow/mffhb.py

@@ -420,8 +420,8 @@ def write_file(self):
 
         f.close()
 
-    @staticmethod
-    def load(f, model, nper=None, ext_unit_dict=None):
+    @classmethod
+    def load(cls, f, model, nper=None, ext_unit_dict=None):
         """
         Load an existing package.
 
@@ -756,7 +756,7 @@ def load(f, model, nper=None, ext_unit_dict=None):
         nfhbx1 = 0
         nfhbx2 = 0
 
-        fhb = ModflowFhb(
+        fhb = cls(
             model,
             nbdtim=nbdtim,
             nflw=nflw,

flopy/modflow/mfflwob.py

@@ -380,8 +380,8 @@ def write_file(self):
 
         return
 
-    @staticmethod
-    def load(f, model, ext_unit_dict=None, check=True):
+    @classmethod
+    def load(cls, f, model, ext_unit_dict=None, check=True):
         """
         Load an existing package.
 
@@ -537,7 +537,7 @@ def load(f, model, ext_unit_dict=None, check=True):
                 model.add_pop_key_list(iufbobsv)
 
         # create ModflowFlwob object instance
-        flwob = ModflowFlwob(
+        flwob = cls(
             model,
             iufbobsv=iufbobsv,
             tomultfb=tomultfb,

flopy/modflow/mfgage.py

@@ -286,8 +286,8 @@ def write_file(self):
         # close the gage file
         f.close()
 
-    @staticmethod
-    def load(f, model, nper=None, ext_unit_dict=None):
+    @classmethod
+    def load(cls, f, model, nper=None, ext_unit_dict=None):
         """
         Load an existing package.
 
@@ -395,7 +395,7 @@ def load(f, model, nper=None, ext_unit_dict=None):
         for file in files:
             filenames.append(os.path.basename(file))
 
-        gagepak = ModflowGage(
+        gagepak = cls(
             model,
             numgage=numgage,
             gage_data=gage_data,

flopy/modflow/mfgmg.py

@@ -318,8 +318,8 @@ def write_file(self):
         f_gmg.write("{}\n".format(self.relax))
         f_gmg.close()
 
-    @staticmethod
-    def load(f, model, ext_unit_dict=None):
+    @classmethod
+    def load(cls, f, model, ext_unit_dict=None):
         """
         Load an existing package.
 
@@ -411,7 +411,7 @@ def load(f, model, ext_unit_dict=None):
                 model.add_pop_key_list(iunitmhc)
 
         # create the gmg object
-        gmg = ModflowGmg(
+        gmg = cls(
             model,
             mxiter=mxiter,
             iiter=iiter,

flopy/modflow/mfhfb.py

@@ -253,8 +253,8 @@ def get_default_dtype(structured=True):
     def get_sfac_columns():
         return ["hydchr"]
 
-    @staticmethod
-    def load(f, model, ext_unit_dict=None):
+    @classmethod
+    def load(cls, f, model, ext_unit_dict=None):
         """
         Load an existing package.
 
@@ -412,7 +412,7 @@ def load(f, model, ext_unit_dict=None):
                 ext_unit_dict, filetype=ModflowHfb.ftype()
             )
 
-        hfb = ModflowHfb(
+        hfb = cls(
             model,
             nphfb=0,
             mxfb=0,

flopy/modflow/mfhob.py

@@ -308,8 +308,8 @@ def write_file(self):
 
         return
 
-    @staticmethod
-    def load(f, model, ext_unit_dict=None, check=True):
+    @classmethod
+    def load(cls, f, model, ext_unit_dict=None, check=True):
         """
         Load an existing package.
 
@@ -492,7 +492,7 @@ def load(f, model, ext_unit_dict=None, check=True):
                     model.add_pop_key_list(iuhobsv)
 
         # create hob object instance
-        hob = ModflowHob(
+        hob = cls(
             model,
             iuhobsv=iuhobsv,
             hobdry=hobdry,

flopy/modflow/mfhyd.py

@@ -286,8 +286,8 @@ def get_default_dtype():
         )
         return dtype
 
-    @staticmethod
-    def load(f, model, ext_unit_dict=None):
+    @classmethod
+    def load(cls, f, model, ext_unit_dict=None):
         """
         Load an existing package.
 
@@ -367,7 +367,7 @@ def load(f, model, ext_unit_dict=None):
                 model.add_pop_key_list(ihydun)
 
         # create hyd instance
-        hyd = ModflowHyd(
+        hyd = cls(
             model,
             nhyd=nhyd,
             ihydun=ihydun,

flopy/modflow/mflak.py

@@ -639,8 +639,8 @@ def write_file(self):
         # close the lak file
         f.close()
 
-    @staticmethod
-    def load(f, model, nper=None, ext_unit_dict=None):
+    @classmethod
+    def load(cls, f, model, nper=None, ext_unit_dict=None):
         """
         Load an existing package.
 
@@ -908,7 +908,7 @@ def load(f, model, nper=None, ext_unit_dict=None):
                     )
                     ipos += 1
 
-        lakpak = ModflowLak(
+        lakpak = cls(
             model,
             options=options,
             nlakes=nlakes,

flopy/modflow/mflmt.py

@@ -170,8 +170,8 @@ def write_file(self):
 
         f.close()
 
-    @staticmethod
-    def load(f, model, ext_unit_dict=None):
+    @classmethod
+    def load(cls, f, model, ext_unit_dict=None):
         """
         Load an existing package.
 
@@ -257,7 +257,7 @@ def load(f, model, ext_unit_dict=None):
                 ext_unit_dict, filetype=ModflowLmt.ftype()
             )
 
-        lmt = ModflowLmt(
+        lmt = cls(
             model,
             output_file_name=output_file_name,
             output_file_unit=output_file_unit,

flopy/modflow/mflpf.py

@@ -437,8 +437,8 @@ def write_file(self, check=True, f=None):
         f.close()
         return
 
-    @staticmethod
-    def load(f, model, ext_unit_dict=None, check=True):
+    @classmethod
+    def load(cls, f, model, ext_unit_dict=None, check=True):
         """
         Load an existing package.
 
@@ -723,7 +723,7 @@ def load(f, model, ext_unit_dict=None, check=True):
                 model.add_pop_key_list(ipakcb)
 
         # create instance of lpf class
-        lpf = ModflowLpf(
+        lpf = cls(
             model,
             ipakcb=ipakcb,
             laytyp=laytyp,

flopy/modflow/mfmlt.py

@@ -128,8 +128,8 @@ def write_file(self):
         """
         pass
 
-    @staticmethod
-    def load(f, model, nrow=None, ncol=None, ext_unit_dict=None):
+    @classmethod
+    def load(cls, f, model, nrow=None, ncol=None, ext_unit_dict=None):
         """
         Load an existing package.
 
@@ -233,7 +233,7 @@ def load(f, model, nrow=None, ncol=None, ext_unit_dict=None):
             )
 
         # create mlt dictionary
-        mlt = ModflowMlt(
+        mlt = cls(
             model,
             mult_dict=mult_dict,
             unitnumber=unitnumber,

flopy/modflow/mfmnw1.py

@@ -209,8 +209,8 @@ def get_default_dtype(structured=True):
         else:
             pass
 
-    @staticmethod
-    def load(f, model, nper=None, gwt=False, nsol=1, ext_unit_dict=None):
+    @classmethod
+    def load(cls, f, model, nper=None, gwt=False, nsol=1, ext_unit_dict=None):
 
         if model.verbose:
             sys.stdout.write("loading mnw1 package file...\n")
@@ -278,7 +278,7 @@ def load(f, model, nper=None, gwt=False, nsol=1, ext_unit_dict=None):
         if openfile:
             f.close()
 
-        return ModflowMnw1(
+        return cls(
             model,
             mxmnw=mxmnw,
             ipakcb=ipakcb,