assign_point_monitor

Monitor.assign_point_monitor(point_position, monitor_quantity='Temperature', monitor_name=None)

Create and assign a point monitor.

Parameters:

point_positionlist or str

List of the [x, y, z] coordinates for the point or name of the point. Also, multiple monitor assignment with list of list with coordinates or list of strings with points 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.AssignPointMonitor

Examples

Create two temperature monitor at the points [0, 0, 0] and [1, 1, 1].

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