assign_sink_to_sheet#

Q3d.assign_sink_to_sheet(sheetname, objectname=None, netname=None, sinkname=None, terminal_type='voltage')[source]#

Generate a sink on a sheet.

Parameters:
sheetname

Name of the sheet to create the sink on.

objectnamestr, optional

Name of the parent object. The default is None.

netnamestr, optional

Name of the net. The default is None.

sinknamestr, optional

Name of the sink. The default is None.

terminal_typestr

Type of the terminal. Options are voltage and current. The default is voltage.

Returns:
pyaedt.modules.Boundary.BoundaryObject

Source object.

References

>>> oModule.AssignSink