Merge branch 'master' into mhanmer/operator_doc_template

Author: ansMHanmer

.github/workflows/test_docker.yml

@@ -51,6 +51,9 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: "Setup Graphviz"
+        uses: ts-graphviz/setup-graphviz@v2
+
       - name: "Install requirements"
         run: pip install -r requirements/requirements_build.txt
 

.github/workflows/tests.yml

@@ -114,6 +114,9 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: "Setup Graphviz"
+        uses: ts-graphviz/setup-graphviz@v2
+
       - name: "Update pip to the latest version and install tox"
         shell: pwsh
         run: |

doc/source/_static/dpf_operators.html

@@ -2,14 +2,14 @@ ansys-sphinx-theme[autoapi]==1.3.1
 enum-tools[sphinx]==0.12.0
 graphviz==0.20.1
 imageio==2.36.0
-imageio-ffmpeg==0.5.1
+imageio-ffmpeg==0.6.0
 nbsphinx==0.9.6
-pypandoc==1.14
+pypandoc==1.15
 pytest-sphinx==0.6.3
 pyvista==0.44.2
 sphinx==7.4.7
 sphinx-copybutton==0.5.2
-sphinx-gallery==0.18.0
+sphinx-gallery==0.19.0
 sphinx-notfound-page==1.1.0
 sphinx-reredirects==0.1.3
 sphinx_design==0.6.1

requirements/requirements_docs.txt

@@ -1,5 +1,5 @@
 importlib-metadata==8.5.0
-numpy==2.2.1
+numpy==2.2.3
 packaging==24.2
-psutil==6.1.1
+psutil==7.0.0
 tqdm==4.67.1

requirements/requirements_install.txt

@@ -1,7 +1,8 @@
 ansys-platform-instancemanagement==1.1.2
 coverage==7.6.11
+graphviz==0.20.1
 imageio==2.36.0
-imageio-ffmpeg==0.5.1
+imageio-ffmpeg==0.6.0
 pytest==8.3.4
 pytest-cov==6.0.0
 pytest-order==1.3.0

requirements/requirements_test.txt

@@ -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/animator.py

@@ -102,6 +102,8 @@ class Homogeneity(Enum):
     mass_flow_rate = 122
     specific_energy = 123
     specific_entropy = 124
+    force_density = 125
+    magnetic_potential = 126
 
 
 class AvailableResult:

src/ansys/dpf/core/available_result.py

@@ -45,7 +45,7 @@
     dpf_vector,
 )
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from ansys.dpf.core.support import Support
 
 from ansys.dpf.gate.integral_types import MutableListInt32

src/ansys/dpf/core/collection_base.py

@@ -28,7 +28,7 @@
 import weakref
 
 from ansys.dpf.core import collection_base, common, errors, server as server_module
-from ansys.dpf.core.mapping_types import types
+from ansys.dpf.core.common import types
 from ansys.dpf.gate import (
     data_processing_capi,
     data_processing_grpcapi,