finesse.model.Model.component_tree

Model.component_tree(root=None)

Retrieves a tree containing the network representing the components connected to the specified root.

Parameters:

rootModelElement

The component to use as the root of the tree.

Returns:

TreeNode

The root tree node, with connected components as branches.

Raises:

ValueError

If the specified root is not a model element.