Merge branch 'master' into dependabot/pip/requirements/ansys-sphinx-theme-1.1.2

Author: PProfizi

.github/workflows/docs.yml

@@ -120,7 +120,7 @@ jobs:
         uses: pyvista/setup-headless-display-action@v2
 
       - name: "Setup Graphviz"
-        uses: ts-graphviz/setup-graphviz@v1
+        uses: ts-graphviz/setup-graphviz@v2
 
       - name: "Install OS packages"
         run: |

doc/source/_static/dpf_operators.html

@@ -4,7 +4,7 @@ graphviz==0.20.1
 imageio==2.35.1
 imageio-ffmpeg==0.5.1
 nbsphinx==0.9.5
-pypandoc==1.13
+pypandoc==1.14
 pytest-sphinx==0.6.3
 pyvista==0.44.1
 sphinx==7.1.0

requirements/requirements_docs.txt

@@ -1,5 +1,5 @@
 importlib-metadata==8.5.0
-numpy==2.1.1
+numpy==2.1.2
 packaging==24.0
 psutil==6.0.0
 tqdm==4.66.1

requirements/requirements_install.txt

@@ -27,6 +27,9 @@ class correlation(Operator):
     ponderation : Field or FieldsContainer
         Field m, optional weighting for correlation
         computation.
+    absoluteValue : bool
+        If true, correlation factor is
+        ||amb||/(||ama||.||bmb||)
 
 
     Examples
@@ -43,12 +46,15 @@ class correlation(Operator):
     >>> op.inputs.fieldB.connect(my_fieldB)
     >>> my_ponderation = dpf.Field()
     >>> op.inputs.ponderation.connect(my_ponderation)
+    >>> my_absoluteValue = bool()
+    >>> op.inputs.absoluteValue.connect(my_absoluteValue)
 
     >>> # Instantiate operator and connect inputs in one line
     >>> op = dpf.operators.math.correlation(
     ...     fieldA=my_fieldA,
     ...     fieldB=my_fieldB,
     ...     ponderation=my_ponderation,
+    ...     absoluteValue=my_absoluteValue,
     ... )
 
     >>> # Get output data
@@ -57,7 +63,13 @@ class correlation(Operator):
     """
 
     def __init__(
-        self, fieldA=None, fieldB=None, ponderation=None, config=None, server=None
+        self,
+        fieldA=None,
+        fieldB=None,
+        ponderation=None,
+        absoluteValue=None,
+        config=None,
+        server=None,
     ):
         super().__init__(name="correlation", config=config, server=server)
         self._inputs = InputsCorrelation(self)
@@ -68,6 +80,8 @@ def __init__(
             self.inputs.fieldB.connect(fieldB)
         if ponderation is not None:
             self.inputs.ponderation.connect(ponderation)
+        if absoluteValue is not None:
+            self.inputs.absoluteValue.connect(absoluteValue)
 
     @staticmethod
     def _spec():
@@ -99,6 +113,13 @@ def _spec():
                     document="""Field m, optional weighting for correlation
         computation.""",
                 ),
+                3: PinSpecification(
+                    name="absoluteValue",
+                    type_names=["bool"],
+                    optional=False,
+                    document="""If true, correlation factor is
+        ||amb||/(||ama||.||bmb||)""",
+                ),
             },
             map_output_pin_spec={
                 0: PinSpecification(
@@ -170,6 +191,8 @@ class InputsCorrelation(_Inputs):
     >>> op.inputs.fieldB.connect(my_fieldB)
     >>> my_ponderation = dpf.Field()
     >>> op.inputs.ponderation.connect(my_ponderation)
+    >>> my_absoluteValue = bool()
+    >>> op.inputs.absoluteValue.connect(my_absoluteValue)
     """
 
     def __init__(self, op: Operator):
@@ -180,6 +203,8 @@ def __init__(self, op: Operator):
         self._inputs.append(self._fieldB)
         self._ponderation = Input(correlation._spec().input_pin(2), 2, op, -1)
         self._inputs.append(self._ponderation)
+        self._absoluteValue = Input(correlation._spec().input_pin(3), 3, op, -1)
+        self._inputs.append(self._absoluteValue)
 
     @property
     def fieldA(self):
@@ -244,6 +269,27 @@ def ponderation(self):
         """
         return self._ponderation
 
+    @property
+    def absoluteValue(self):
+        """Allows to connect absoluteValue input to the operator.
+
+        If true, correlation factor is
+        ||amb||/(||ama||.||bmb||)
+
+        Parameters
+        ----------
+        my_absoluteValue : bool
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.math.correlation()
+        >>> op.inputs.absoluteValue.connect(my_absoluteValue)
+        >>> # or
+        >>> op.inputs.absoluteValue(my_absoluteValue)
+        """
+        return self._absoluteValue
+
 
 class OutputsCorrelation(_Outputs):
     """Intermediate class used to get outputs from

src/ansys/dpf/core/operators/math/correlation.py

@@ -15,24 +15,24 @@ class from_scoping(Operator):
     """Extracts a meshed region from another meshed region based on a
     scoping. Regarding the property fields of the meshed region: the
     'Elemental', 'Face', and 'Nodal' property fields are scoped to the
-    elements or nodes of the output mesh, the 'Global' property fields
-    are transferred from the input mesh to the output mesh without
-    changes, and the rest of the property fields are not present in
-    the output mesh.
+    elements, faces or nodes of the output mesh, the 'Global' property
+    fields are transferred from the input mesh to the output mesh
+    without changes, and the rest of the property fields are not
+    present in the output mesh.
 
     Parameters
     ----------
     scoping : Scoping
-        If nodal scoping, then the scoping is
+        If nodal/face scoping, then the scoping is
         transposed respecting the inclusive
         pin
     inclusive : int, optional
         If inclusive == 1 then all the elements/faces
-        adjacent to the nodes ids in input
-        are added, if inclusive == 0, only
-        the elements/faces which have all
-        their nodes in the scoping are
-        included
+        adjacent to the nodes/faces ids in
+        input are added, if inclusive == 0,
+        only the elements/faces which have
+        all their nodes/faces in the scoping
+        are included
     nodes_only : bool, optional
         Returns mesh with nodes only (without any
         elements or property fields). default
@@ -95,19 +95,19 @@ def _spec():
         description = """Extracts a meshed region from another meshed region based on a
             scoping. Regarding the property fields of the meshed
             region: the 'Elemental', 'Face', and 'Nodal' property
-            fields are scoped to the elements or nodes of the output
-            mesh, the 'Global' property fields are transferred from
-            the input mesh to the output mesh without changes, and the
-            rest of the property fields are not present in the output
-            mesh."""
+            fields are scoped to the elements, faces or nodes of the
+            output mesh, the 'Global' property fields are transferred
+            from the input mesh to the output mesh without changes,
+            and the rest of the property fields are not present in the
+            output mesh."""
         spec = Specification(
             description=description,
             map_input_pin_spec={
                 1: PinSpecification(
                     name="scoping",
                     type_names=["scoping"],
                     optional=False,
-                    document="""If nodal scoping, then the scoping is
+                    document="""If nodal/face scoping, then the scoping is
         transposed respecting the inclusive
         pin""",
                 ),
@@ -116,11 +116,11 @@ def _spec():
                     type_names=["int32"],
                     optional=True,
                     document="""If inclusive == 1 then all the elements/faces
-        adjacent to the nodes ids in input
-        are added, if inclusive == 0, only
-        the elements/faces which have all
-        their nodes in the scoping are
-        included""",
+        adjacent to the nodes/faces ids in
+        input are added, if inclusive == 0,
+        only the elements/faces which have
+        all their nodes/faces in the scoping
+        are included""",
                 ),
                 3: PinSpecification(
                     name="nodes_only",
@@ -218,7 +218,7 @@ def __init__(self, op: Operator):
     def scoping(self):
         """Allows to connect scoping input to the operator.
 
-        If nodal scoping, then the scoping is
+        If nodal/face scoping, then the scoping is
         transposed respecting the inclusive
         pin
 
@@ -241,11 +241,11 @@ def inclusive(self):
         """Allows to connect inclusive input to the operator.
 
         If inclusive == 1 then all the elements/faces
-        adjacent to the nodes ids in input
-        are added, if inclusive == 0, only
-        the elements/faces which have all
-        their nodes in the scoping are
-        included
+        adjacent to the nodes/faces ids in
+        input are added, if inclusive == 0,
+        only the elements/faces which have
+        all their nodes/faces in the scoping
+        are included
 
         Parameters
         ----------

src/ansys/dpf/core/operators/mesh/from_scoping.py

@@ -23,11 +23,11 @@ class from_scopings(Operator):
         pin
     inclusive : int, optional
         If inclusive == 1 then all the elements/faces
-        adjacent to the nodes ids in input
-        are added, if inclusive == 0, only
-        the elements/faces which have all
-        their nodes in the scoping are
-        included
+        adjacent to the nodes/faces ids in
+        input are added, if inclusive == 0,
+        only the elements/faces which have
+        all their nodes/faces in the scoping
+        are included
     nodes_only : bool, optional
         Returns mesh with nodes only (without any
         elements). default is false.
@@ -104,11 +104,11 @@ def _spec():
                     type_names=["int32"],
                     optional=True,
                     document="""If inclusive == 1 then all the elements/faces
-        adjacent to the nodes ids in input
-        are added, if inclusive == 0, only
-        the elements/faces which have all
-        their nodes in the scoping are
-        included""",
+        adjacent to the nodes/faces ids in
+        input are added, if inclusive == 0,
+        only the elements/faces which have
+        all their nodes/faces in the scoping
+        are included""",
                 ),
                 3: PinSpecification(
                     name="nodes_only",
@@ -228,11 +228,11 @@ def inclusive(self):
         """Allows to connect inclusive input to the operator.
 
         If inclusive == 1 then all the elements/faces
-        adjacent to the nodes ids in input
-        are added, if inclusive == 0, only
-        the elements/faces which have all
-        their nodes in the scoping are
-        included
+        adjacent to the nodes/faces ids in
+        input are added, if inclusive == 0,
+        only the elements/faces which have
+        all their nodes/faces in the scoping
+        are included
 
         Parameters
         ----------

src/ansys/dpf/core/operators/mesh/from_scopings.py

@@ -33,10 +33,11 @@ class on_property(Operator):
         If element scoping is requested on a nodal
         named selection, if inclusive == 1
         then all the elements/faces adjacent
-        to the nodes ids in input are added,
-        if inclusive == 0, only the
+        to the nodes/faces ids in input are
+        added, if inclusive == 0, only the
         elements/faces which have all their
-        nodes in the scoping are included
+        nodes/faces in the scoping are
+        included
 
 
     Examples
@@ -150,10 +151,11 @@ def _spec():
                     document="""If element scoping is requested on a nodal
         named selection, if inclusive == 1
         then all the elements/faces adjacent
-        to the nodes ids in input are added,
-        if inclusive == 0, only the
+        to the nodes/faces ids in input are
+        added, if inclusive == 0, only the
         elements/faces which have all their
-        nodes in the scoping are included""",
+        nodes/faces in the scoping are
+        included""",
                 ),
             },
             map_output_pin_spec={
@@ -347,10 +349,11 @@ def inclusive(self):
         If element scoping is requested on a nodal
         named selection, if inclusive == 1
         then all the elements/faces adjacent
-        to the nodes ids in input are added,
-        if inclusive == 0, only the
+        to the nodes/faces ids in input are
+        added, if inclusive == 0, only the
         elements/faces which have all their
-        nodes in the scoping are included
+        nodes/faces in the scoping are
+        included
 
         Parameters
         ----------

src/ansys/dpf/core/operators/scoping/on_property.py

@@ -25,11 +25,11 @@ class transpose(Operator):
     meshed_region : MeshedRegion or MeshesContainer
     inclusive : int, optional
         If inclusive == 1 then all the elements/faces
-        adjacent to the nodes ids in input
-        are added, if inclusive == 0, only
-        the elements/faces which have all
-        their nodes in the scoping are
-        included
+        adjacent to the nodes/faces ids in
+        input are added, if inclusive == 0,
+        only the elements/faces which have
+        all their nodes/faces in the scoping
+        are included
     requested_location : str, optional
         Output scoping location for meshes with
         nodes, faces and elements. by
@@ -114,11 +114,11 @@ def _spec():
                     type_names=["int32"],
                     optional=True,
                     document="""If inclusive == 1 then all the elements/faces
-        adjacent to the nodes ids in input
-        are added, if inclusive == 0, only
-        the elements/faces which have all
-        their nodes in the scoping are
-        included""",
+        adjacent to the nodes/faces ids in
+        input are added, if inclusive == 0,
+        only the elements/faces which have
+        all their nodes/faces in the scoping
+        are included""",
                 ),
                 9: PinSpecification(
                     name="requested_location",
@@ -253,11 +253,11 @@ def inclusive(self):
         """Allows to connect inclusive input to the operator.
 
         If inclusive == 1 then all the elements/faces
-        adjacent to the nodes ids in input
-        are added, if inclusive == 0, only
-        the elements/faces which have all
-        their nodes in the scoping are
-        included
+        adjacent to the nodes/faces ids in
+        input are added, if inclusive == 0,
+        only the elements/faces which have
+        all their nodes/faces in the scoping
+        are included
 
         Parameters
         ----------