From 2398bc3e2d9855fa409845cfd9959627d870cc54 Mon Sep 17 00:00:00 2001
From: Harshal Pohekar <106588300+hpohekar@users.noreply.github.com>
Date: Fri, 23 Aug 2024 16:27:37 +0530
Subject: [PATCH] docs: Add EventsManger examples (#3232)

* docs: Add EventsManger examples

* docs: more examples
---
 doc/source/user_guide/events.rst | 52 ++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

diff --git a/doc/source/user_guide/events.rst b/doc/source/user_guide/events.rst
index 1b63e7aa1ff..52b7438db09 100644
--- a/doc/source/user_guide/events.rst
+++ b/doc/source/user_guide/events.rst
@@ -22,3 +22,55 @@ The following code triggers a callback at the end of every iteration.
   >>>     print("Iteration ended. Index = ", event_info.index)
   >>>
   >>> callback_id = solver.events.register_callback(SolverEvent.ITERATION_ENDED, on_iteration_ended)
+  >>> 
+
+Examples
+--------
+
+.. code-block:: python
+
+  >>> from ansys.fluent.core import MeshingEvent, SolverEvent
+  >>> from ansys.fluent.core.utils.event_loop import execute_in_event_loop_threadsafe
+  >>> from ansys.fluent.visualization.matplotlib import matplot_windows_manager
+  >>> from ansys.fluent.visualization.pyvista import pyvista_windows_manager
+  >>> from ansys.fluent.visualization import Graphics
+  >>>
+  >>> graphics = Graphics(session=solver)
+  >>>
+  >>> contour1 = graphics.Contours["contour-1"]
+  >>> contour1.field = "temperature"
+  >>> contour1.surfaces_list = ["symmetry"]
+  >>>
+  >>> contour2 = graphics.Contours["contour-2"]
+  >>> contour2.field = "velocity-magnitude"
+  >>> contour2.surfaces_list = ["symmetry"]
+  >>> 
+  >>> @execute_in_event_loop_threadsafe
+  >>> def auto_refersh_call_back_iteration(session, event_info):
+  >>>   if event_info.index % 5 == 0:
+  >>>       pyvista_windows_manager.refresh_windows(session.id, ["contour-1", "contour-2"])
+  >>>       matplot_windows_manager.refresh_windows("", ["residual"])
+  >>>
+  >>> callback_itr_id = solver.events.register_callback(SolverEvent.ITERATION_ENDED, auto_refersh_call_back_iteration)
+  >>>
+  >>> @execute_in_event_loop_threadsafe
+  >>> def initialize_call_back(session, event_info):
+  >>>     pyvista_windows_manager.refresh_windows(session.id, ["contour-1", "contour-2"])
+  >>>     matplot_windows_manager.refresh_windows("", ["residual"])
+  >>>
+  >>> callback_init_id = solver.events.register_callback(SolverEvent.SOLUTION_INITIALIZED, initialize_call_back)
+  >>>
+  >>> callback_data_read_id = solver.events.register_callback(SolverEvent.DATA_LOADED, initialize_call_back)
+  >>>
+  >>> def on_case_loaded(session, event_info):
+  >>>     print("Case loaded. Index = ", event_info.index)
+  >>>
+  >>> def on_case_loaded_with_args(x, y, session, event_info):
+  >>>     print(f"Case loaded with {x}, {y}. Index = ", event_info.index)
+  >>>
+  >>> callback = meshing.events.register_callback(MeshingEvent.CASE_LOADED, on_case_loaded)
+  >>>
+  >>> callback_case = solver.events.register_callback(SolverEvent.CASE_LOADED, on_case_loaded)
+  >>>
+  >>> callback_case_with_args = solver.events.register_callback(SolverEvent.CASE_LOADED, on_case_loaded_with_args, 12, y=42)
+  >>>