monitor_streaming#
Module for monitors management.
Classes:
|
Manages monitors (Fluent residuals and report definitions monitors). |
- class ansys.fluent.core.streaming_services.monitor_streaming.MonitorsManager(session_id, service)#
Bases:
StreamingService
Manages monitors (Fluent residuals and report definitions monitors).
- Parameters:
- session_id
str
Session ID.
- service
MonitorsService
Monitors streaming service.
- session_id
Methods:
__init__
(session_id, service)__init__ method of MonitorsManager class.
get_monitor_set_data
(monitor_set_name[, ...])Get monitor set data.
Get monitor set names.
get_monitor_set_plot
(monitor_set_name, ...)Get monitor set plot.
get_monitor_set_prop
(monitor_set_name, property)Get monitor set property.
refresh
(session, event_info)Refresh plots on-initialized and data-read events.
- __init__(session_id, service)#
__init__ method of MonitorsManager class.
- get_monitor_set_data(monitor_set_name, start_index=0, end_index=None)#
Get monitor set data.
- Parameters:
- monitor_set_name
str
Name of the monitor set.
- start_index: int, optional
Start index to provide data.
- end_index: int, optional
End index to provide data.
- monitor_set_name
- Returns:
Tuple
[np.array
,Dict
[str
,np.array
]]Tuple containing two elements: a numpy array of x-axis values and a dictionary associating monitor names of type
str
to numpy arrays of y-axis values.
- get_monitor_set_names()#
Get monitor set names.
- Parameters:
- None
- Returns:
List
[str
]List of all monitor set names.
- get_monitor_set_plot(monitor_set_name, *args, **kwargs)#
Get monitor set plot.
- get_monitor_set_prop(monitor_set_name, property)#
Get monitor set property.