Merge pull request #520 from PMEAL/Removing_template

removed the template_sphere

Author: jgostick

OpenPNM/Network/__Cubic__.py

@@ -448,46 +448,3 @@ def domain_area(self, face):
     def subdivide(self, pores=[], shape=[], labels=[]):
         topo.subdivide(network=self, pores=pores, shape=shape, labels=labels)
     subdivide.__doc__ = topo.subdivide.__doc__
-
-    def template_sphere_shell(outer_radius=None, inner_radius=0):
-        r"""
-        This method generates an image array of a sphere shell for a cubic network.
-
-        Parameters
-        ----------
-        outer_radius : array_like
-        Number of the nodes in the outer radius of the shell
-
-        inner_radius : float
-        Number of the nodes in the inner radius of the shell
-
-        """
-
-        if outer_radius is None:
-            raise Exception('No outer radius has been sent!')
-        if inner_radius is None:
-            raise Exception('Number of nodes in the inner radius cannot be '
-                            'None!')
-        rmax = np.array(outer_radius, ndmin=1)
-        rmin = np.array(inner_radius, ndmin=1)
-        s_rmax = np.size(rmax)
-        s_rmin = np.size(rmin)
-        if not ((s_rmax in [1, 3]) and (s_rmin in [1, 3])):
-            raise Exception('In this method, each radius can be scalar or '
-                            'array with components along all xyz directions.')
-        s_u_rmax = np.size(np.unique(rmax))
-        s_u_rmin = np.size(np.unique(rmin))
-        if not ((s_u_rmax == 1) and (s_u_rmin == 1)):
-            raise Exception('In this method, all components of radius should '
-                            'be unique values along all xyz directions.')
-        pnum = 2 * np.ones(3) * rmax - 1
-        Rx, Ry, Rz = np.array(pnum, dtype=np.int32)
-        x, y, z = np.indices((Rx, Ry, Rz))
-        x = x - (Rx - 1)/2
-        y = y - (Ry - 1)/2
-        z = z - (Rz - 1)/2
-        img = x ** 2 + y ** 2 + z ** 2 < np.unique(rmax) ** 2
-        if not np.all(rmin == 0):
-            img_min = x ** 2 + y ** 2 + z ** 2 > np.unique(rmin) ** 2
-            img = img * img_min
-        return (img)

OpenPNM/Utilities/__topology__.py

@@ -679,3 +679,46 @@ def merge_pores(self, network, pores, labels=['merged']):
         Pnew = network.Ps[-1]
         self.connect_pores(network, pores1=Pnew, pores2=Pn, labels=labels)
         self.trim(network=network, pores=pores)
+
+    def template_sphere_shell(outer_radius=None, inner_radius=0):
+        r"""
+        This method generates an image array of a sphere shell for a cubic network.
+
+        Parameters
+        ----------
+        outer_radius : array_like
+        Number of the nodes in the outer radius of the shell
+
+        inner_radius : float
+        Number of the nodes in the inner radius of the shell
+
+        """
+
+        if outer_radius is None:
+            raise Exception('No outer radius has been sent!')
+        if inner_radius is None:
+            raise Exception('Number of nodes in the inner radius cannot be '
+                            'None!')
+        rmax = _np.array(outer_radius, ndmin=1)
+        rmin = _np.array(inner_radius, ndmin=1)
+        s_rmax = _np.size(rmax)
+        s_rmin = _np.size(rmin)
+        if not ((s_rmax in [1, 3]) and (s_rmin in [1, 3])):
+            raise Exception('In this method, each radius can be scalar or '
+                            'array with components along all xyz directions.')
+        s_u_rmax = _np.size(_np.unique(rmax))
+        s_u_rmin = _np.size(_np.unique(rmin))
+        if not ((s_u_rmax == 1) and (s_u_rmin == 1)):
+            raise Exception('In this method, all components of radius should '
+                            'be unique values along all xyz directions.')
+        pnum = 2 * _np.ones(3) * rmax - 1
+        Rx, Ry, Rz = _np.array(pnum, dtype=_np.int32)
+        x, y, z = _np.indices((Rx, Ry, Rz))
+        x = x - (Rx - 1)/2
+        y = y - (Ry - 1)/2
+        z = z - (Rz - 1)/2
+        img = x ** 2 + y ** 2 + z ** 2 < _np.unique(rmax) ** 2
+        if not _np.all(rmin == 0):
+            img_min = x ** 2 + y ** 2 + z ** 2 > _np.unique(rmin) ** 2
+            img = img * img_min
+        return (img)

test/unit/Network/CubicTest.py

@@ -148,19 +148,3 @@ def test_domain_length(self):
         L = self.net.domain_length(face_1=self.net.pores('top'),
                                    face_2=self.net.pores('bottom'))
         assert sp.allclose(L, 4, rtol=1e-02)
-
-    def test_template_sphere_shell(self):
-        from OpenPNM.Utilities import topology
-        spacing = sp.array([0.5])
-        r_o = [5, 5, 5]
-        r_in = [2, 2, 2]
-        img = OpenPNM.Network.Cubic.template_sphere_shell(outer_radius=r_o,
-                                                          inner_radius=r_in)
-        pn_sphere = OpenPNM.Network.Cubic(template=img, spacing=spacing)
-        assert pn_sphere.Np == 452
-        img2 = OpenPNM.Network.Cubic.template_sphere_shell(outer_radius=r_o)
-        pn_sphere = OpenPNM.Network.Cubic(template=img2, spacing=spacing)
-        L1 = sp.amax(topology.find_pores_distance(network=pn_sphere,
-                                                  pores1=pn_sphere.Ps,
-                                                  pores2=pn_sphere.Ps))
-        assert L1 < sp.sqrt(3) * 8 * 0.5

test/unit/Utilities/TopologyTest.py

@@ -33,3 +33,19 @@ def test_merge_pores(self):
         topo.merge_pores(network=net, pores=P, labels=['merged'])
         assert net.Np == 95
         assert net.Nt == 222
+
+    def test_template_sphere_shell(self):
+        from OpenPNM.Utilities import topology
+        spacing = sp.array([0.5])
+        r_o = [5, 5, 5]
+        r_in = [2, 2, 2]
+        img = topology.template_sphere_shell(outer_radius=r_o,
+                                             inner_radius=r_in)
+        pn_sphere = OpenPNM.Network.Cubic(template=img, spacing=spacing)
+        assert pn_sphere.Np == 452
+        img2 = topology.template_sphere_shell(outer_radius=r_o)
+        pn_sphere = OpenPNM.Network.Cubic(template=img2, spacing=spacing)
+        L1 = sp.amax(topology.find_pores_distance(network=pn_sphere,
+                                                  pores1=pn_sphere.Ps,
+                                                  pores2=pn_sphere.Ps))
+        assert L1 < sp.sqrt(3) * 8 * 0.5