create_lumped_rlc_between_objects#

Hfss.create_lumped_rlc_between_objects(startobj, endobject, axisdir=0, sourcename=None, rlctype='Parallel', Rvalue=None, Lvalue=None, Cvalue=None, bound_on_plane=True)[source]#

Create a lumped RLC taking the closest edges of two objects.

Parameters:
startobj

Starting object for the integration line.

endobject

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.

sourcenamestr, optional

Perfect H name. The default is None.

rlctypestr, optional

Type of the RLC. Options are "Parallel" and "Serial". The default is "Parallel".

Rvalueoptional

Resistance value in ohms. The default is None, in which case this parameter is disabled.

Lvalueoptional

Inductance value in H. The default is None, in which case this parameter is disabled.

Cvalueoptional

Capacitance value in F. The default is None, in which case this parameter is disabled.

bound_on_planebool, optional

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

Returns:
pyaedt.modules.Boundary.BoundaryObject or bool

Boundary object if successful, False otherwise.

References

>>> oModule.AssignLumpedRLC

Examples

Create two boxes for creating a lumped RLC named 'LumpedRLC'.

>>> box1 = hfss.modeler.create_box([0, 0, 50], [10, 10, 5],
...                                           "rlc1", "copper")
>>> box2 = hfss.modeler.create_box([0, 0, 60], [10, 10, 5],
...                                           "rlc2", "copper")
>>> rlc = hfss.create_lumped_rlc_between_objects("rlc1", "rlc2", hfss.AxisDir.XPos,
...                                              "Lumped RLC", Rvalue=50,
...                                              Lvalue=1e-9, Cvalue = 1e-6)
PyAEDT INFO: Connection Correctly created