create_lumped_port#

Patch.create_lumped_port(reference_layer, opposite_side=False, port_name=None, axisdir=None)[source]#

Create a parametrized lumped port.

Parameters:
reference_layerclass:pyaedt.modeler.stackup_3d.Layer3D

Reference layer, which is the ground layer in most cases.

opposite_sidebool, optional

Change the side where the port is created.

port_namestr, optional

Name of the lumped port.

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.

Returns:
bool

Examples

>>> from pyaedt import Hfss
>>> from pyaedt.modeler.stackup_3d import Stackup3D
>>> hfss = Hfss()
>>> my_stackup = Stackup3D(hfss, 2.5e9)
>>> gnd = my_stackup.add_ground_layer("gnd")
>>> my_stackup.add_dielectric_layer("diel1", thickness=1.5, material="Duroid (tm)")
>>> top = my_stackup.add_signal_layer("top")
>>> my_patch = top.add_patch(frequency=None, patch_width=51, patch_name="MLPatch")
>>> my_stackup.resize_around_element(my_patch)
>>> my_patch.create_lumped_port(gnd)