finesse.tracing.forest.TraceForest.find_potential_mismatch_couplings

TraceForest.find_potential_mismatch_couplings(self, TraceForest other=None) → tuple

Retrieves the node couplings which are potentially mode mismatched. If other is not given then the couplings which are local to this forest only will be found, otherwise couplings between this forest and other will be retrieved.

If this forest is asymmetric, then calling this method is equivalent to calling TraceForest.find_intersection_couplings().

This method is used internally for obtaining all the possible mode mismatch couplings between a changing trace forest (held by a modal simulation) and the main model trace forest.

Parameters

otherTraceForest

Find dependencies from a different trace forest than this one when checking for mode mismatch couplings.

Returns

couplingstuple

A tuple of the node couplings where each element is (from_node, to_node).