create_impedance_between_objects#

Hfss.create_impedance_between_objects(startobj, endobject, axisdir=0, sourcename=None, resistance=50, reactance=0, is_infground=False, bound_on_plane=True)[source]#

Create an impedance taking the closest edges of two objects.

Parameters:
startobj

Starting object for the integration line.

endobject

Ending object for the integration line.

axisdirint or pyaedt.application.Analysis.Analysis.AxisDir, optional

Position of the port. It should be one of the values for Application.AxisDir, which are: XNeg, YNeg, ZNeg, XPos, YPos, and ZPos. The default is Application.AxisDir.XNeg.

sourcenamestr, optional

Name of the impedance. The default is None.

resistancefloat, optional

Resistance value in ohms. The default is 50. If None, this parameter is disabled.

reactanceoptional

Reactance value in ohms. The default is 0. If None, this parameter is disabled.

is_infgroundbool, optional

Whether the impendance is an infinite ground. The default is False.

bound_on_planebool, optional

Whether to create the impedance on the plane orthogonal to AxisDir. The default is True.

Returns:
pyaedt.modules.Boundary.BoundaryObject or bool

Boundary object if successful, False otherwise.

References

>>> oModule.AssignImpedance

Examples

Create two boxes for creating an impedance named 'ImpedanceExample'.

>>> box1 = hfss.modeler.create_box([0, 0, 70], [10, 10, 5],
...                                           "box1", "copper")
>>> box2 = hfss.modeler.create_box([0, 0, 80], [10, 10, 5],
...                                           "box2", "copper")
>>> impedance = hfss.create_impedance_between_objects("box1", "box2", hfss.AxisDir.XPos,
...                                                   "ImpedanceExample", 100, 50)
pyaedt info: Connection Correctly created