assign_surface_monitor#

Monitor.assign_surface_monitor(surface_name, monitor_quantity='Temperature', monitor_name=None)[source]#

Assign a surface monitor.

Parameters:

surface_namestr or list: Name of the surface or list of names.
monitor_quantitystr or list, optional: Quantity being monitored. The default is "Temperature".
monitor_namestr, optional: Name of the monitor. The default is None, in which case the name is randomly generated.

Returns:

str or list: Monitor name or list of monitor names 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'