Plotter windows manager

The PlotterWindowsManager class provides for managing and directly interacting with Matplotlib windows. By registering these methods with EventsManager, you can update plots during run time.

The following example updates window-1 and window-2 during solution initialization and whenever data is read. During the calculation, it also updates both windows at the end of every time step.

from ansys.fluent.visualization import Plots
from ansys.fluent.visualization.plotter import plotter_windows_manager

plots_session = Plots(session)

#Create xy plot.
plot1 = plots_session.XYPlots["plot-1"]
plot1.surfaces = ['symmetry']
plot1.y_axis_function = "temperature"


# Plot XY plot on window-1.
plot1.plot("window-1")

#Create monitor plot.
monitor1 = plots_session.Monitors["monitor-1"]
monitor1.monitor_set_name = "residual"


#Plot monitor on window-2.
monitor1.plot("window-2")

# Create callback that refreshes window-1 and window-2.
def auto_refresh_plot(session_id, event_info):
    plotter_windows_manager.refresh_windows(session_id, ["window-1", "window-2"])

#Register this callback with server events.
cb_init_id = session.events_manager.register_callback('InitializedEvent', auto_refresh_plot)
cb_data_read_id = session.events_manager.register_callback('DataReadEvent', auto_refresh_plot)
cb_time_step_ended_id = session.events_manager.register_callback('TimestepEndedEvent', auto_refresh_plot)

class ansys.fluent.visualization.plotter.plotter_windows_manager.PlotterWindowsManager(*args, **kwargs)

Provides for managing Plotter windows.

animate_windows(session_id='', windows_id=[])

Animate windows.

Parameters:

session_idstr, optional

Session ID for animating the windows that belong only to this session. The default is "", in which case the windows in all sessions are animated.

windows_idList[str], optional

List of IDs for the windows to animate. The default is [], in which case all windows are animated.

Raises

——

NotImplementedError

If not implemented.

Return type:

None

close_windows(session_id='', windows_id=[])

Close windows.

Parameters:

session_idstr, optional

Session ID for closing the windows that belong only to this session. The default is "", in which case the windows in all sessions are closed.

windows_idList[str], optional

List of IDs for the windows to close. The default is [], in which all windows are closed.

Return type:

None

open_window(window_id=None)

Open a new window.

Parameters:

window_idstr, optional

ID for the new window. The default is None, in which case a unique ID is automatically assigned.

Returns:

str

ID for the new window.

Return type:

str

plot(object, window_id=None, grid=(1, 1), position=0, show=True)

Draw a plot.

Parameters:

object: PlotDefn

Object to plot.

window_idstr, optional

Window ID for the plot. The default is None, in which case a unique ID is assigned.

Raises:

RuntimeError

If the window does not support the object.

Return type:

None

refresh_windows(session_id='', windows_id=[])

Refresh windows.

Parameters:

session_idstr, optional

Session ID for refreshing the windows that belong only to this session. The default is "", in which case the windows in all sessions are refreshed.

windows_idList[str], optional

IDs of the windows to refresh. The default is [], in which case all windows are refreshed.

Return type:

None

save_graphic(window_id, format)

Save a graphic.

Parameters:

window_idstr

Window ID for the graphic to save.

formatstr

Graphic file format. Supported formats are EPS, JPEG, JPG, PDF, PGF, PNG, PS, RAW, RGBA, SVG, SVGZ, TIF, and TIFF.

Raises:

ValueError

If window does not support specified format.

Return type:

None

set_object_for_window(object, window_id)

Associate a visualization object with a running window instance.

Parameters:

objectPlotDefn

Post object to associate with a running window instance.

window_idstr

Window ID for the association.

Raises:

RuntimeError

If the window does not support the object.

Return type:

None