Expose shell_layer parameter in Animator.animate() and FieldsContainer.animate()

Author: PProfizi

src/ansys/dpf/core/animator.py

@@ -60,6 +60,7 @@ def animate_workflow(
         save_as="",
         mode_number=None,
         scale_factor=1.0,
+        shell_layer=core.shell_layers.top,
         **kwargs,
     ):
         unit = loop_over.unit
@@ -121,6 +122,7 @@ def render_frame(frame):
                 field,
                 deform_by=deform,
                 scale_factor_legend=scale_factor[frame],
+                shell_layer=shell_layer,
                 **kwargs,
             )
             kwargs_in = _sort_supported_kwargs(bound_method=self._plotter.add_text, **freq_kwargs)
@@ -267,33 +269,37 @@ def animate(
         save_as: str = None,
         scale_factor: Union[float, Sequence[float]] = 1.0,
         freq_kwargs: dict = None,
+        shell_layer: core.shell_layers = core.shell_layers.top,
         **kwargs,
     ):
         """
         Animate the workflow of the Animator, using inputs.
 
         Parameters
         ----------
-        loop_over : Field
+        loop_over:
             Field of values to loop over.
             Can for example be a subset of sets of TimeFreqSupport.time_frequencies.
             The unit of the Field will be displayed if present.
-        output_name : str, optional
+        output_name:
             Name of the workflow output to use as Field for each frame's contour.
             Defaults to "to_render".
-        input_name : list of str, optional
+        input_name:
             Name of the workflow inputs to feed loop_over values into.
             Defaults to "loop_over".
-        save_as : str, optional
+        save_as:
             Path of file to save the animation to. Defaults to None. Can be of any format supported
             by pyvista.Plotter.write_frame (.gif, .mp4, ...).
-        scale_factor : float, list, optional
+        scale_factor:
             Scale factor to apply when warping the mesh. Defaults to 1.0. Can be a list to make
             scaling frequency-dependent.
-        freq_kwargs : dict, optional
+        freq_kwargs:
             Dictionary of kwargs given to the :func:`pyvista.Plotter.add_text` method, used to
             format the frequency information. Can also contain a "fmt" key,
             defining the format for the frequency displayed with a string such as ".3e".
+        shell_layer:
+            Enum used to set the shell layer if the field to plot
+            contains shell elements. Defaults to top layer.
         **kwargs : optional
             Additional keyword arguments for the animator.
             Used by :func:`pyvista.Plotter` (off_screen, cpos, ...),
@@ -314,6 +320,7 @@ def animate(
             save_as=save_as,
             scale_factor=scale_factor,
             freq_kwargs=freq_kwargs,
+            shell_layer=shell_layer,
             **kwargs,
         )
 

src/ansys/dpf/core/fields_container.py

@@ -26,9 +26,17 @@
 Contains classes associated with the DPF FieldsContainer.
 """
 
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 from ansys import dpf
 from ansys.dpf.core import errors as dpf_errors, field
 from ansys.dpf.core.collection_base import CollectionBase
+from ansys.dpf.core.common import shell_layers
+
+if TYPE_CHECKING:
+    from ansys.dpf.core import Operator, Result
 
 
 class FieldsContainer(CollectionBase["field.Field"]):
@@ -543,23 +551,39 @@ def plot(self, label_space: dict = None, **kwargs):
             plt.add_field(field=f, **kwargs)
         plt.show_figure(**kwargs)
 
-    def animate(self, save_as=None, deform_by=None, scale_factor=1.0, **kwargs):
+    def animate(
+        self,
+        save_as: str = None,
+        deform_by: Union[FieldsContainer, Result, Operator] = None,
+        scale_factor: Union[float, Sequence[float]] = 1.0,
+        shell_layer: shell_layers = shell_layers.top,
+        **kwargs,
+    ):
         """Create an animation based on the Fields contained in the FieldsContainer.
 
         This method creates a movie or a gif based on the time ids of a FieldsContainer.
         For kwargs see pyvista.Plotter.open_movie/add_text/show.
 
         Parameters
         ----------
-        save_as : Path of file to save the animation to. Defaults to None. Can be of any format
+        save_as:
+            Path of file to save the animation to. Defaults to None. Can be of any format
             supported by pyvista.Plotter.write_frame (.gif, .mp4, ...).
-        deform_by : FieldsContainer, Result, Operator, optional
+        deform_by:
             Used to deform the plotted mesh. Must return a FieldsContainer of the same length as
             self, containing 3D vector Fields of distances.
             Defaults to None, which takes self if possible. Set as False to force static animation.
         scale_factor : float, list, optional
             Scale factor to apply when warping the mesh. Defaults to 1.0. Can be a list to make
             scaling frequency-dependent.
+        shell_layer:
+            Enum used to set the shell layer if the field to plot
+            contains shell elements. Defaults to top layer.
+        **kwargs:
+            Additional keyword arguments for the animator.
+            Used by :func:`pyvista.Plotter` (off_screen, cpos, ...),
+            or by :func:`pyvista.Plotter.open_movie`
+            (framerate, quality, ...)
         """
         from ansys.dpf.core.animator import Animator
 
@@ -655,6 +679,7 @@ def animate(self, save_as=None, deform_by=None, scale_factor=1.0, **kwargs):
             loop_over=loop_over_field,
             save_as=save_as,
             scale_factor=scale_factor,
+            shell_layer=shell_layer,
             **kwargs,
         )