template_cylinder_annulus

openpnm.topotools.template_cylinder_annulus(height, outer_radius, inner_radius=0)[source]

This method generates an image array of a disc-ring.

It is useful for passing to Cubic networks as a template to make circular-shaped 2D networks.

Parameters
  • height (int) – The height of the cylinder

  • outer_radius (int) – Number of nodes in the outer radius of the cylinder

  • inner_radius (int) – Number of the nodes in the inner radius of the annulus. A value of 0 will result in a solid cylinder.

Returns

im – A Numpy array containing 1’s to demarcate the disc-ring, and 0’s elsewhere.

Return type

array_like