get_mutual_coupling

Q3d.get_mutual_coupling(source1, sink1, source2, sink2, calculation='ACL', setup_sweep_name=None, variations=None)

Get mutual coupling between two terminals. User has to provide the pair, source and sink of each terminal. If the provided sinks are not part of the original matrix, a new matrix will be created.

Parameters:

source1str

First element source.

sink1str

First element sink.

source2str

Second element source.

sink2str

Second element sink.

calculationstr, optional

Calculation type. Available options are: "ACL", "ACR", "DCL", "DCR". The default is "ACL".

setup_sweep_namestr, optional

Name of the setup. The default is None, in which case the nominal_adaptive setup is used. Be sure to build a setup string in the form of "SetupName : SetupSweep", where SetupSweep is the sweep name to use in the export or LastAdaptive.

variationsdict, optional

Dictionary of all families including the primary sweep. The default is None which uses all variations of the setup.

Returns:

pyaedt.modules.solutions.SolutionData or bool

Solution Data object if successful, False otherwise.

Examples

>>> from pyaedt import Q3d
>>> aedtapp = Q3d()
>>> data = aedtapp.modeler.get_mutual_coupling("a1", "a2", "b1", "b2", calculation="DCL")