assign_lumped_rlc_to_sheet#

Hfss.assign_lumped_rlc_to_sheet(assignment, start_direction=0, name=None, rlc_type='Parallel', resistance=None, inductance=None, capacitance=None)[source]#

Create a lumped RLC taking one sheet.

Parameters:

assignmentstr: Name of the sheet to apply the boundary to.
start_directionint, pyaedt.application.Analysis.Analysis.AxisDir or list, optional: Direction of the integration line. It should be one of the values for Application.AxisDir, which are: XNeg, YNeg, ZNeg, XPos, YPos, and ZPos. It also accepts the list of the start point and end point with the format [[xstart, ystart, zstart], [xend, yend, zend]] The default is Application.AxisDir.XNeg.
namestr, optional: Lumped RLC name. The default is None.
rlc_typestr, optional: Type of the RLC. Options are "Parallel" and "Serial". The default is "Parallel".
resistancefloat, optional: Resistance value in ohms. The default is None, in which case this parameter is disabled.
inductancefloat, optional: Inductance value in Henry (H). The default is None, in which case this parameter is disabled.
capacitancefloat, optional: Capacitance value in farads (F). The default is None, in which case this parameter is disabled.

Returns:

pyaedt.modules.Boundary.BoundaryObject: Boundary object if successful, False otherwise.

References

>>> oModule.AssignLumpedRLC

Examples

Create a sheet and use it to create a lumped RLC.

>>> sheet = hfss.modeler.create_rectangle(hfss.PLANE.XY,
...                                       [0, 0, -90], [10, 2], name="RLCSheet",
...                                        matname="Copper")
>>> lumped_rlc_to_sheet = hfss.assign_lumped_rlc_to_sheet(sheet.name,hfss.AxisDir.XPos,resistance=50,
...                                                       inductance=1e-9,capacitance=1e-6)
>>> type(lumped_rlc_to_sheet)
<class 'pyaedt.modules.Boundary.BoundaryObject'>
>>> h2 = hfss.assign_lumped_rlc_to_sheet(sheet.name,[sheet.bottom_edge_x.midpoint,
...                                      sheet.bottom_edge_y.midpoint],resistance=50,inductance=1e-9,
...                                      capacitance=1e-6)