create_lumped_port_to_sheet

Hfss.create_lumped_port_to_sheet(sheet_name, axisdir=0, impedance=50, portname=None, renorm=True, deemb=False, reference_object_list=[])[source]

Create a lumped port taking one sheet.

Parameters
sheet_namestr

Name of the sheet.

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.

deembbool, optional

Whether to deembed the port. The default is False.

reference_object_listlist, optional

For a driven terminal solution only, a list of reference conductors. The default is [].

Returns
pyaedt.modules.Boundary.BoundaryObject

Boundary object.

References

>>> oModule.AssignLumpedPort

Examples

Create a rectangle sheet that will be used to create a lumped port named 'LumpedPortFromSheet'.

>>> rectangle = hfss.modeler.primitives.create_rectangle(hfss.PLANE.XY,
...                                                      [0, 0, 0], [10, 2], name="lump_port",
...                                                      matname="copper")
>>> h1 = hfss.create_lumped_port_to_sheet(rectangle.name, hfss.AxisDir.XNeg, 50,
...                                  "LumpedPortFromSheet", True, False)