assign_current_source_to_sheet#

Hfss.assign_current_source_to_sheet(assignment, start_direction=0, name=None)[source]#

Create a current source 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: Name of the source. The default is None.

Returns:

pyaedt.modules.Boundary.BoundaryObject: Boundary object.

References

>>> oModule.AssignCurrent

Examples

Create a sheet and assign some current to it.

>>> sheet = hfss.modeler.create_rectangle(hfss.PLANE.XY, [0, 0, -50],
...                                                  [5, 1], name="CurrentSheet", matname="copper")
>>> hfss.assign_current_source_to_sheet(sheet.name,hfss.AxisDir.XNeg,"CurrentSheetExample")
'CurrentSheetExample'
>>> c1 = hfss.assign_current_source_to_sheet(sheet.name,[sheet.bottom_edge_x.midpoint,
...                                     sheet.bottom_edge_y.midpoint])