Fix missing images in ablation example documentation (#3911)

examples/00-fluent/modeling_ablation.py

@@ -78,6 +78,8 @@
 import ansys.fluent.core as pyfluent
 from ansys.fluent.core import examples
 from ansys.fluent.visualization.pyvista import Graphics
+import os
+from pathlib import Path
 
 ####################################################################################
 # Download example file
@@ -248,6 +250,7 @@
     "189",
     "constant",
     "0",
+    "0",
     "yes",
     "yes",
     "0.7",
@@ -355,10 +358,33 @@
 # Post Processing
 # ==================================================================================
 
+# Configure picture settings for high-quality exports
+graphics = solver.results.graphics
+if graphics.picture.use_window_resolution.is_active():
+    graphics.picture.use_window_resolution = False
+graphics.picture.x_resolution = 1920
+graphics.picture.y_resolution = 1080
+
 ###############################################
-# Display plots
+# Display and save plots
 # =============
 
+# Save residual plot
+solver.solution.monitor.residual.plot()
+solver.results.graphics.picture.save_picture(file_name="ablation-residual.png")
+
+# Save drag force plot
+solver.solution.monitor.report_plots["drag_force_x"].display()
+solver.results.graphics.picture.save_picture(file_name="ablation-drag_force_x.png")
+
+# Save averaged pressure plot
+solver.solution.monitor.report_plots["pressure_avg_abl_wall"].display()
+solver.results.graphics.picture.save_picture(file_name="ablation-avg_pressure.png")
+
+# Save recede point plot
+solver.solution.monitor.report_plots["recede_point"].display()
+solver.results.graphics.picture.save_picture(file_name="ablation-recede_point.png")
+
 # %%
 # .. image:: ../../_static/ablation-residual.png
 #    :align: center
@@ -405,6 +431,8 @@
     "surfaces_list": ["mid_plane"],
 }
 solver.results.graphics.contour.display(object_name="contour_pressure")
+solver.results.graphics.views.auto_scale()
+solver.results.graphics.picture.save_picture(file_name="ablation-pressure.png")
 
 solver.results.graphics.contour.create(name="contour_mach")
 solver.results.graphics.contour["contour_mach"] = {
@@ -423,6 +451,9 @@
 contour1.field = "pressure"
 contour1.surfaces_list = ["mid_plane"]
 contour1.display()
+# Save the image for documentation
+graphics_session1.save_picture("ablation-pressure.png")
+
 # %%
 # .. image:: ../../_static/ablation-pressure.png
 #    :align: center
@@ -436,6 +467,9 @@
 contour1.range.auto_range_off.minimum = 0.5
 contour1.range.auto_range_off.maximum = 3.0
 contour1.display()
+# Save the image for documentation and thumbnail
+graphics_session1.save_picture("ablation-mach-number.png")
+graphics_session1.save_picture("ablation-mach-number-thumbnail.png")
 
 # %%
 # .. image:: ../../_static/ablation-mach-number.png

fix_ablation_images_issue.md

@@ -0,0 +1,75 @@
+# Fix for Issue #3911: Ablation Example Missing Plots/Pictures
+
+## Problem
+
+The ablation example in PyFluent is missing the plot images in the documentation. The example references several images in the documentation, but these images are not present in the `doc/source/_static` folder:
+
+- ablation-residual.png
+- ablation-drag_force_x.png
+- ablation-avg_pressure.png
+- ablation-recede_point.png
+- ablation-pressure.png
+- ablation-mach-number.png
+- ablation-mach-number-thumbnail.png
+
+The issue affects the documentation page at: https://fluent.docs.pyansys.com/version/stable/examples/00-fluent/modeling_ablation.html
+
+## Solution
+
+The solution has two parts:
+
+1. Modify the `modeling_ablation.py` example to explicitly save the plot images
+2. Run the example to generate the images and copy them to the documentation's static folder
+
+## Implementation Steps
+
+### Step 1: Modify the Ablation Example
+
+The `modeling_ablation.py` example needs to be modified to save the images. The example already creates the plots but doesn't save them to disk with the correct filenames.
+
+The following changes were made to `examples/00-fluent/modeling_ablation.py`:
+
+- Added code to configure picture export settings
+- Added code to save each plot with the appropriate filename
+- Added code to save the contour images and thumbnails
+
+### Step 2: Run the Example and Copy Images
+
+Created a utility script `copy_ablation_images.py` that:
+
+1. Runs the modified ablation example to generate all the necessary plot images
+2. Copies the generated images to the documentation's static directory
+
+## Testing
+
+After running the utility script and rebuilding the documentation, all the images should appear correctly in the ablation example page.
+
+## Files Modified
+
+1. `examples/00-fluent/modeling_ablation.py`
+   - Added code to save the plot images with the correct filenames
+
+2. New files created:
+   - `copy_ablation_images.py`: Utility script to run the example and copy images to the documentation static folder
+
+## Steps to Verify Fix
+
+1. Run the `copy_ablation_images.py` script:
+   ```
+   python copy_ablation_images.py
+   ```
+
+2. Verify that the following images have been copied to `doc/source/_static`:
+   - ablation-residual.png
+   - ablation-drag_force_x.png
+   - ablation-avg_pressure.png
+   - ablation-recede_point.png
+   - ablation-pressure.png
+   - ablation-mach-number.png
+   - ablation-mach-number-thumbnail.png
+
+3. Rebuild the documentation and verify that the images appear correctly in the ablation example page.
+
+## Notes
+
+The issue appears to be that the ablation example references images using Sphinx directives, but the actual images were never created or added to the documentation static folder. The modified example now explicitly saves these images, ensuring they're available for the documentation build process.