check_network_health

Project.check_network_health()[source]

This method checks the topological health of the network

The following aspects are checked for:

  1. Isolated pores

  2. Disconnected clusters of pores

  3. Duplicate throats

  4. Headless throats

  5. Bidirectional throats

Returns

health – A dictionary containing the offending pores or throat numbers under each named key.

Return type

dict

Notes

It also returns a list of which pores and throats should be trimmed from the network to restore health. This list is a suggestion only, and is based on keeping the largest cluster and trimming the others.

  • Does not yet check for duplicate pores

  • Does not yet suggest which throats to remove

  • This is just a ‘check’ and does not ‘fix’ the problems it finds