set_outlets

MercuryIntrusion.set_outlets(pores=[], overwrite=False)

Sets the locations through which defender exits the network.

This is only necessary for calculating the percolation threshold.

Parameters
  • pores (array_like) – Locations where the defender can exit the network. Any defender that does not have access to these sites will be trapped.

  • overwrite (bool) – If True then all existing outlet locations will be removed and then the supplied locations will be added. If False (default), then supplied locations are added to any already existing outlet locations.