assign_surface_monitor#

Icepak.assign_surface_monitor(face_name, monitor_type='Temperature', monitor_name=None)[source]#

Assign a surface monitor.

Parameters:

face_namestr: Name of the face.
monitor_typestr, optional: Type of the monitor. The default is "Temperature".
monitor_namestr, optional: Name of the monitor. The default is None, in which case the default name is used.

Returns:

str: Monitor name when successful, False when failed.

References

>>> oModule.AssignFaceMonitor

Examples

Create a rectangle named "Surface1" and assign a temperature monitor to that surface.

>>> surface = icepak.modeler.create_rectangle(icepak.PLANE.XY,[0, 0, 0],[10, 20],name="Surface1")
>>> icepak.assign_surface_monitor("Surface1", monitor_name="monitor")
'monitor'