docs: example on the steady vortex dynamics (#4452)

This PR provides a comprehensive example of simulating steady vortex
dynamics, specifically focusing on vortex behavior within continuously
stirred tank reactors.

The example tries to follow the provided guidelines with #4378 and uses
the new API implementation.

Thanks!

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Sean Pearson <[email protected]>

Author: 3 people

.github/workflows/execute-examples-weekly.yml

@@ -157,6 +157,11 @@ jobs:
         run: |
           python examples/00-fluent/single_battery_cell_workflow.py
 
+      - name: Execute steady_vortex.py
+        run: |
+          python examples/00-fluent/steady_vortex.py
+
+
       # https://github.com/ansys/pyfluent/issues/4157
       # - name: Execute conjugate_heat_transfer.py
       #   run: |

doc/changelog.d/4452.documentation.md

@@ -0,0 +1 @@
+Example on the steady vortex dynamics

doc/source/_static/steady_vortex/contour.png

@@ -152,7 +152,7 @@ def _stop_fluent_container(gallery_conf, fname):
     # path where to save gallery generated examples
     "gallery_dirs": ["examples"],
     # Pattern to search for example files
-    "filename_pattern": r"exhaust_system_settings_api\.py|external_compressible_flow\.py|mixing_elbow_settings_api\.py|modeling_cavitation\.py|species_transport\.py|ahmed_body_workflow\.py|brake\.py|DOE_ML\.py|radiation_headlamp\.py|parametric_static_mixer_1\.py|conjugate_heat_transfer\.py|tyler_sofrin_modes\.py|lunar_lander_thermal\.py|modeling_ablation\.py|frozen_rotor_workflow\.py|mixing_tank_workflow\.py|single_battery_cell_workflow\.py|",
+    "filename_pattern": r"exhaust_system_settings_api\.py|external_compressible_flow\.py|mixing_elbow_settings_api\.py|modeling_cavitation\.py|species_transport\.py|ahmed_body_workflow\.py|brake\.py|DOE_ML\.py|radiation_headlamp\.py|parametric_static_mixer_1\.py|conjugate_heat_transfer\.py|tyler_sofrin_modes\.py|lunar_lander_thermal\.py|modeling_ablation\.py|frozen_rotor_workflow\.py|mixing_tank_workflow\.py|single_battery_cell_workflow\.py|steady_vortex\.py",
     # Do not execute examples
     "plot_gallery": False,
     # Remove the "Download all examples" button from the top level gallery