sink#

Q3d.sink(assignment=None, direction=0, name=None, net_name=None, terminal_type='voltage')#

Generate a sink on a face of an object or a group of faces or face ids.

The face ID is selected based on the axis direction. It is the face that has the maximum/minimum in this axis direction.

Parameters:

assignmentstr, int or list or ansys.aedt.core.modeler.cad.object_3d.Object3d: Name of the object or face ID or face ID list.
directionint, optional: Initial axis direction. Options are 0 to 5. The default is 0.
namestr, optional: Name of the source. The default is None.
net_namestr, optional: Name of the net. The default is None, in which case the object_name is considered.
terminal_typestr: Type of the terminal. Options are voltage and current. The default is voltage.

Returns:

References

>>> oModule.AssignSource