sink#

Q3d.sink(objects=None, axisdir=0, name=None, net_name=None, terminal_type='voltage')[source]#

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:
objectsstr, int or list or pyaedt.modeler.cad.object3d.Object3d

Name of the object or face ID or face ID list.

axisdirint, 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:
pyaedt.modules.Boundary.BoundaryObject

Sink object.

References

>>> oModule.AssignSource