create_circuit_port_between_objects

Hfss.create_circuit_port_between_objects(startobj, endobject, axisdir=0, impedance=50, portname=None, renorm=True, renorm_impedance=50, deemb=False)[source]

Create a circuit port taking the closest edges of two objects.

Parameters
startobj

First (starting) object for the integration line.

endobject

Second (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.

impedancefloat, optional

Port impedance. The default is 50.

portnamestr, optional

Name of the port. The default is None.

renormbool, optional

Whether to renormalize the mode. The default is True.

renorm_impedancefloat or str, optional

Renormalize impedance. The default is 50.

deembbool, optional

Whether to deembed the port. The default is False.

Returns
pyaedt.modules.Boundary.BoundaryObject

Boundary object.

References

>>> oModule.AssignCircuitPort

Examples

Create two boxes that will be used to create a circuit port named 'CircuitExample'.

>>> box1 = hfss.modeler.primitives.create_box([0, 0, 80], [10, 10, 5],
...                                           "BoxCircuit1", "copper")
>>> box2 = hfss.modeler.primitives.create_box([0, 0, 100], [10, 10, 5],
...                                           "BoxCircuit2", "copper")
>>> hfss.create_circuit_port_between_objects("BoxCircuit1", "BoxCircuit2",
...                                          hfss.AxisDir.XNeg, 50,
...                                          "CircuitExample", True, 50, False)
'CircuitExample'