neat.NET.getCompartmentalization

NET.getCompartmentalization(Iz, returntype='node index')[source]

Returns a compartmentalization for the NET tree where each pair of compartments is separated by an Iz of at least Iz. The compartmentalization is coded as a list of list, each sublist representing a the nodes closest to the root associated with the compartment.

Parameters

  • Iz (float) – the minimum Iz separating the compartments

  • returntype (str ('node index', 'node')) – either returns the node indices or the node objects

Returns

the compartments

Return type

list of lists