refactor(rtd): refactor functions to hide private functions (#989)

flopy/discretization/structuredgrid.py

@@ -778,7 +778,8 @@ def get_cell_vertices(self, i, j):
             used in the Shapefile export utilities
         :param i: (int) cell row number
         :param j: (int) cell column number
-        :return: list of x,y cell vertices
+        Returns
+        ------- list of x,y cell vertices
         """
         self._copy_cache = False
         cell_verts = [

flopy/discretization/unstructuredgrid.py

@@ -219,7 +219,8 @@ def get_cell_vertices(self, cellid):
         Method to get a set of cell vertices for a single cell
             used in the Shapefile export utilities
         :param cellid: (int) cellid number
-        :return: list of x,y cell vertices
+        Returns
+        ------- list of x,y cell vertices
         """
         self._copy_cache = False
         cell_vert = list(zip(self.xvertices[cellid], self.yvertices[cellid]))

flopy/discretization/vertexgrid.py

@@ -258,7 +258,8 @@ def get_cell_vertices(self, cellid):
         Method to get a set of cell vertices for a single cell
             used in the Shapefile export utilities
         :param cellid: (int) cellid number
-        :return: list of x,y cell vertices
+        Returns
+        ------- list of x,y cell vertices
         """
         self._copy_cache = False
         cell_verts = list(zip(self.xvertices[cellid], self.yvertices[cellid]))

flopy/modflow/mfag.py

@@ -202,14 +202,14 @@ def __init__(
 
         # setup the package parent class
         if unitnumber is None:
-            unitnumber = ModflowAg.defaultunit()
+            unitnumber = ModflowAg._defaultunit()
 
         if filenames is None:
             filenames = [None]
         elif isinstance(filenames, str):
             filenames = [filenames]
 
-        name = [ModflowAg.ftype()]
+        name = [ModflowAg._ftype()]
         units = [unitnumber]
         extra = [""]
 
@@ -903,11 +903,11 @@ def load(cls, f, model, nper=0, ext_unit_dict=None):
         )
 
     @staticmethod
-    def defaultunit():
+    def _defaultunit():
         return 69
 
     @staticmethod
-    def ftype():
+    def _ftype():
         return "AG"
 
     @property

flopy/modflow/mfbas.py

@@ -82,11 +82,11 @@ class ModflowBas(Package):
     """
 
     @staticmethod
-    def ftype():
+    def _ftype():
         return "BAS6"
 
     @staticmethod
-    def defaultunit():
+    def _defaultunit():
         return 13
 
     def __init__(
@@ -109,7 +109,7 @@ def __init__(
         """
 
         if unitnumber is None:
-            unitnumber = ModflowBas.defaultunit()
+            unitnumber = ModflowBas._defaultunit()
 
         # set filenames
         if filenames is None:
@@ -118,7 +118,7 @@ def __init__(
             filenames = [filenames]
 
         # Fill namefile items
-        name = [ModflowBas.ftype()]
+        name = [ModflowBas._ftype()]
         units = [unitnumber]
         extra = [""]
 
@@ -394,7 +394,7 @@ def load(cls, f, model, ext_unit_dict=None, check=True, **kwargs):
         filenames = [None]
         if ext_unit_dict is not None:
             unitnumber, filenames[0] = model.get_ext_dict_attr(
-                ext_unit_dict, filetype=ModflowBas.ftype()
+                ext_unit_dict, filetype=ModflowBas._ftype()
             )
 
         # create bas object and return

flopy/modflow/mfbcf.py

@@ -115,7 +115,7 @@ def __init__(
     ):
 
         if unitnumber is None:
-            unitnumber = ModflowBcf.defaultunit()
+            unitnumber = ModflowBcf._defaultunit()
 
         # set filenames
         if filenames is None:
@@ -130,13 +130,13 @@ def __init__(
         if ipakcb is not None:
             fname = filenames[1]
             model.add_output_file(
-                ipakcb, fname=fname, package=ModflowBcf.ftype()
+                ipakcb, fname=fname, package=ModflowBcf._ftype()
             )
         else:
             ipakcb = 0
 
         # Fill namefile items
-        name = [ModflowBcf.ftype()]
+        name = [ModflowBcf._ftype()]
         units = [unitnumber]
         extra = [""]
 
@@ -520,7 +520,7 @@ def load(cls, f, model, ext_unit_dict=None):
         filenames = [None, None]
         if ext_unit_dict is not None:
             unitnumber, filenames[0] = model.get_ext_dict_attr(
-                ext_unit_dict, filetype=ModflowBcf.ftype()
+                ext_unit_dict, filetype=ModflowBcf._ftype()
             )
             if ipakcb > 0:
                 iu, filenames[1] = model.get_ext_dict_attr(
@@ -554,9 +554,9 @@ def load(cls, f, model, ext_unit_dict=None):
         return bcf
 
     @staticmethod
-    def ftype():
+    def _ftype():
         return "BCF6"
 
     @staticmethod
-    def defaultunit():
+    def _defaultunit():
         return 15

flopy/modflow/mfbct.py

@@ -40,12 +40,12 @@ def __init__(
 
         # set default unit number of one is not specified
         if unitnumber is None:
-            unitnumber = ModflowBct.defaultunit()
+            unitnumber = ModflowBct._defaultunit()
 
         # Call ancestor's init to set self.parent, extension, name and unit
         # number
         Package.__init__(
-            self, model, extension, ModflowBct.ftype(), unitnumber
+            self, model, extension, ModflowBct._ftype(), unitnumber
         )
 
         self.url = "bct.htm"
@@ -168,9 +168,9 @@ def write_file(self):
         return
 
     @staticmethod
-    def ftype():
+    def _ftype():
         return "BCT"
 
     @staticmethod
-    def defaultunit():
+    def _defaultunit():
         return 35

flopy/modflow/mfchd.py

@@ -115,7 +115,7 @@ def __init__(
 
         # set default unit number if one is not specified
         if unitnumber is None:
-            unitnumber = ModflowChd.defaultunit()
+            unitnumber = ModflowChd._defaultunit()
 
         # set filenames
         if filenames is None:
@@ -124,7 +124,7 @@ def __init__(
             filenames = [filenames]
 
         # Fill namefile items
-        name = [ModflowChd.ftype()]
+        name = [ModflowChd._ftype()]
         units = [unitnumber]
         extra = [""]
 
@@ -163,8 +163,16 @@ def __init__(
         self.options = options
         self.parent.add_package(self)
 
-    def ncells(self):
-        # Returns the  maximum number of cells that have recharge (developed for MT3DMS SSM package)
+    def _ncells(self):
+        """Maximum number of cells that have constant heads (developed for
+        MT3DMS SSM package).
+
+        Returns
+        -------
+        ncells: int
+            maximum number of chd cells
+
+        """
         return self.stress_period_data.mxact
 
     def write_file(self):
@@ -222,7 +230,7 @@ def get_default_dtype(structured=True):
         return dtype
 
     @staticmethod
-    def get_sfac_columns():
+    def _get_sfac_columns():
         return ["shead", "ehead"]
 
     @classmethod
@@ -274,9 +282,9 @@ def load(cls, f, model, nper=None, ext_unit_dict=None, check=True):
         )
 
     @staticmethod
-    def ftype():
+    def _ftype():
         return "CHD"
 
     @staticmethod
-    def defaultunit():
+    def _defaultunit():
         return 24

flopy/modflow/mfde4.py

@@ -135,7 +135,7 @@ def __init__(
 
         # set default unit number of one is not specified
         if unitnumber is None:
-            unitnumber = ModflowDe4.defaultunit()
+            unitnumber = ModflowDe4._defaultunit()
 
         # set filenames
         if filenames is None:
@@ -144,7 +144,7 @@ def __init__(
             filenames = [filenames]
 
         # Fill namefile items
-        name = [ModflowDe4.ftype()]
+        name = [ModflowDe4._ftype()]
         units = [unitnumber]
         extra = [""]
 
@@ -310,7 +310,7 @@ def load(cls, f, model, ext_unit_dict=None):
         filenames = [None]
         if ext_unit_dict is not None:
             unitnumber, filenames[0] = model.get_ext_dict_attr(
-                ext_unit_dict, filetype=ModflowDe4.ftype()
+                ext_unit_dict, filetype=ModflowDe4._ftype()
             )
 
         de4 = cls(
@@ -330,9 +330,9 @@ def load(cls, f, model, ext_unit_dict=None):
         return de4
 
     @staticmethod
-    def ftype():
+    def _ftype():
         return "DE4"
 
     @staticmethod
-    def defaultunit():
+    def _defaultunit():
         return 28

flopy/modflow/mfdis.py

@@ -149,7 +149,7 @@ def __init__(
 
         # set default unit number of one is not specified
         if unitnumber is None:
-            unitnumber = ModflowDis.defaultunit()
+            unitnumber = ModflowDis._defaultunit()
 
         # set filenames
         if filenames is None:
@@ -158,7 +158,7 @@ def __init__(
             filenames = [filenames]
 
         # Fill namefile items
-        name = [ModflowDis.ftype()]
+        name = [ModflowDis._ftype()]
         units = [unitnumber]
         extra = [""]
 
@@ -1024,7 +1024,7 @@ def load(cls, f, model, ext_unit_dict=None, check=True):
         filenames = [None]
         if ext_unit_dict is not None:
             unitnumber, filenames[0] = model.get_ext_dict_attr(
-                ext_unit_dict, filetype=ModflowDis.ftype()
+                ext_unit_dict, filetype=ModflowDis._ftype()
             )
 
         # create dis object instance
@@ -1063,11 +1063,11 @@ def load(cls, f, model, ext_unit_dict=None, check=True):
         return dis
 
     @staticmethod
-    def ftype():
+    def _ftype():
         return "DIS"
 
     @staticmethod
-    def defaultunit():
+    def _defaultunit():
         return 11
 
 

flopy/modflow/mfdisu.py

@@ -231,7 +231,7 @@ def __init__(
 
         # set default unit number of one is not specified
         if unitnumber is None:
-            unitnumber = ModflowDisU.defaultunit()
+            unitnumber = ModflowDisU._defaultunit()
 
         # set filenames
         if filenames is None:
@@ -240,7 +240,7 @@ def __init__(
             filenames = [filenames]
 
         # Fill namefile items
-        name = [ModflowDisU.ftype()]
+        name = [ModflowDisU._ftype()]
         units = [unitnumber]
         extra = [""]
 
@@ -794,7 +794,7 @@ def load(cls, f, model, ext_unit_dict=None, check=False):
         filenames = [None]
         if ext_unit_dict is not None:
             unitnumber, filenames[0] = model.get_ext_dict_attr(
-                ext_unit_dict, filetype=ModflowDisU.ftype()
+                ext_unit_dict, filetype=ModflowDisU._ftype()
             )
 
         # create dis object instance
@@ -920,11 +920,11 @@ def write_file(self):
         return
 
     @staticmethod
-    def ftype():
+    def _ftype():
         return "DISU"
 
     @staticmethod
-    def defaultunit():
+    def _defaultunit():
         return 11
 
         # def get_node_coordinates(self):