create_wave_port_from_sheet

Hfss.create_wave_port_from_sheet(sheet, deemb=0, axisdir=0, impedance=50, nummodes=1, portname=None, renorm=True, terminal_references=None)[source]

Create a waveport on sheet objects created starting from sheets.

Parameters
sheetstr or int or pyaedt.modeler.Object3d.Object3d

Name of the sheet.

deembfloat, optional

Deembedding value distance in model units. The default is 0.

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 0 for Application.AxisDir.XNeg.

impedancefloat, optional

Port impedance. The default is 50.

nummodesint, optional

Number of modes. The default is 1.

portnamestr, optional

Name of the port. The default is None.

renormbool, optional

Whether to renormalize the mode. The default is True.

terminal_referenceslist, optional

In Driven Terminal Simulation it is the list of conductors for Port Terminal Definitions.

Returns
pyaedt.modules.Boundary.BoundaryObject

Boundary object.

References

>>> oModule.AssignWavePort

Examples

Create a circle sheet that will be used to create a wave port named 'WavePortFromSheet'.

>>> origin_position = hfss.modeler.Position(0, 0, 0)
>>> circle = hfss.modeler.primitives.create_circle(hfss.PLANE.YZ,
...                                                origin_position, 10, name="WaveCircle")
>>> hfss.solution_type = "Modal"
>>> port = hfss.create_wave_port_from_sheet(circle, 5, hfss.AxisDir.XNeg, 40, 2,
...                                         "WavePortFromSheet", True)
>>> port[0].name
'WavePortFromSheet'