create_circuit_port_from_edges

Hfss.create_circuit_port_from_edges(edge_signal, edge_gnd, port_name='', port_impedance='50', renormalize=False, renorm_impedance='50', deembed=False)[source]

Create a circuit port from two edges.

The integration line is from edge 2 to edge 1.

Parameters
edge_signalint

Edge ID of the signal.

edge_gndint

Edge ID of the ground.

port_namestr, optional

Name of the port. The default is "".

port_impedanceint, str, or float, optional

Impedance. The default is "50". You can also enter a string that looks like this: "50+1i*55".

renormalizebool, optional

Whether to renormalize the mode. The default is False. This parameter is ignored for a driven terminal.

renorm_impedancestr, optional

Impedance. The default is 50

deembedbool. optional

Whether to deembed the port. The default is False

Returns
str

Name of the port created when successful, False otherwise.

References

>>> oModule.AssignCircuitPort

Examples

Create two rectangles in the XY plane. Select the first edge of each rectangle created previously. Create a circuit port from the first edge of the first rectangle toward the first edge of the second rectangle.

>>> plane = hfss.PLANE.XY
>>> rectangle1 = hfss.modeler.primitives.create_rectangle(plane, [10, 10, 10], [10, 10],
...                                                       name="rectangle1_for_port")
>>> edges1 = hfss.modeler.primitives.get_object_edges(rectangle1.id)
>>> first_edge = edges1[0]
>>> rectangle2 = hfss.modeler.primitives.create_rectangle(plane, [30, 10, 10], [10, 10],
...                                                       name="rectangle2_for_port")
>>> edges2 = hfss.modeler.primitives.get_object_edges(rectangle2.id)
>>> second_edge = edges2[0]
>>> hfss.solution_type = "Modal"
>>> hfss.create_circuit_port_from_edges(first_edge, second_edge, port_name="PortExample",
...                                     port_impedance=50.1, renormalize=False,
...                                     renorm_impedance="50")
'PortExample'