assign_sink_to_objectface#

Q3d.assign_sink_to_objectface(assignment, direction=0, name=None, net_name=None)[source]#

Generate a sink on a face of an object.

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

Parameters:
assignmentstr, int

Name of the object or face ID.

directionint, optional

Initial axis direction. Options are 0 to 5. The default is 0.

namestr, optional

Name of the sink. The default is None.

net_namestr, optional

Name of the net. The default is None, in which case the object_name is considered.

Returns:
pyaedt.modules.Boundary.BoundaryObject

Sink object.

References

>>> oModule.AssignSink