assign_point_monitor

Icepak.assign_point_monitor(point_position: list, monitor_type: str | None = 'Temperature', monitor_name: str | None = None) → str | bool

Create and assign a point monitor.

Parameters:

point_positionlist

List of the [x, y, z] coordinates for the point.

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 temperature monitor at the point [1, 1, 1].

>>> icepak.assign_point_monitor([1, 1, 1], monitor_name="monitor1")
'monitor1'