assign_sink_to_sheet#

Q3d.assign_sink_to_sheet(assignment, object_name=None, net_name=None, sink_name=None, terminal_type='voltage')[source]#

Generate a sink on a sheet.

Parameters:
assignment

Name of the sheet to create the sink on.

object_namestr, optional

Name of the parent object. The default is None.

net_namestr, optional

Name of the net. The default is None.

sink_namestr, 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