create_wave_port_between_objects

Hfss.create_wave_port_between_objects(startobj, endobject, axisdir=0, impedance=50, nummodes=1, portname=None, renorm=True, deembed_dist=0, port_on_plane=True, add_pec_cap=False)[source]

Create a waveport 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.

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.

deembed_distfloat, optional

Deembed distance in millimeters. The default is 0, in which case deembed is disabled.

port_on_planebool, optional

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

add_pec_capbool, optional

The default is False.

Returns
pyaedt.modules.Boundary.BoundaryObject

Boundary object.

References

>>> oModule.AssignWavePort

Examples

Create two boxes that will be used to create a wave port named 'WavePort'.

>>> box1 = hfss.modeler.primitives.create_box([0,0,0], [10,10,5],
...                                           "BoxWave1", "copper")
>>> box2 = hfss.modeler.primitives.create_box([0, 0, 10], [10, 10, 5],
...                                           "BoxWave2", "copper")
>>> wave_port = hfss.create_wave_port_between_objects("BoxWave1", "BoxWave2",
...                                                   hfss.AxisDir.XNeg, 50, 1,
...                                                   "WavePort", False)
pyaedt info: Connection Correctly created