assign_point_monitor_to_vertex#

Monitor.assign_point_monitor_to_vertex(vertex_id, monitor_quantity='Temperature', monitor_name=None)[source]#

Create and assign a point monitor to a vertex.

Parameters:

vertex_idint or list

ID of the vertex or list of IDs.

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