assign_voltage_source_to_sheet#

Hfss.assign_voltage_source_to_sheet(sheet_name, axisdir=0, sourcename=None)[source]#

Create a voltage source taking one sheet.

Parameters:
sheet_namestr

Name of the sheet to apply the boundary to.

axisdirint, 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.

sourcenamestr, optional

Name of the source. The default is None.

Returns:
pyaedt.modules.Boundary.BoundaryObject

Boundary object.

References

>>> oModule.AssignVoltage

Examples

Create a sheet and assign to it some voltage.

>>> sheet = hfss.modeler.create_rectangle(hfss.PLANE.XY,
...                                                  [0, 0, -70], [10, 2], name="VoltageSheet",
...                                                  matname="copper")
>>> v1 = hfss.assign_voltage_source_to_sheet(sheet.name, hfss.AxisDir.XNeg, "VoltageSheetExample")
>>> v2 = hfss.assign_voltage_source_to_sheet(sheet.name, [sheet.bottom_edge_x.midpoint,
...                                     sheet.bottom_edge_y.midpoint], 50, "LumpedPortFromSheet", True,
...                                     False)