assign_point_monitor_in_object

Icepak.assign_point_monitor_in_object(name, monitor_type='Temperature', monitor_name=None)

Assign a point monitor in the centroid of a specific object.

Parameters:

namestr

Name of the object to assign monitor point to.

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.AssignPointMonitor

Examples

Create a box named "BlockBox1" and assign a temperature monitor point to that object.

>>> box = icepak.modeler.create_box([1, 1, 1],[3, 3, 3],"BlockBox1","copper")
>>> icepak.assign_point_monitor(box.name, monitor_name="monitor2")
"'monitor2'