Merge branch 'main' into dependabot/pip/requirements/coverage-7.11.0

Author: PProfizi

.github/workflows/docs.yml

@@ -79,7 +79,7 @@ jobs:
       - name: "Build the wheel"
         shell: pwsh
         run: |
-          tox -e build-wheel
+          tox -e build-wheel -- "any"
 
       - name: "Expose the wheel"
         shell: bash

doc/source/_static/dpf_operators.html

@@ -5,7 +5,7 @@ requires = ["setuptools>=61.0.0", "wheel"]
 [project]
 # Check https://setuptools.pypa.io/en/stable/userguide/quickstart.html for all available sections
 name = "ansys-dpf-core"
-version = "0.14.2.dev0"
+version = "0.14.3.dev0"
 description = "Data Processing Framework - Python Core "
 readme = "README.md"
 requires-python = ">=3.9, <4"

pyproject.toml

@@ -25,16 +25,16 @@ class time_freq_support_get_attribute(Operator):
     ----------
     time_freq_support: TimeFreqSupport
     property_name: str
-        Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs".
-    property_identifier: int, optional
-        Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping.
+        Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs", "step_id_from_harmonic_index".
+    property_identifier: int or Scoping, optional
+        Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping, for "step_id_from_harmonic_index" : the harmonic index.
     property_identifier_2: int, optional
         Additional pin for properties "set_id" and "cummulative_index": the substep id (if none, last substep is considered).
 
     Returns
     -------
     property: float or Field or Scoping
-        Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", and a Field otherwise.
+        Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", an int for "step_id_from_harmonic_index" and a Field otherwise.
 
     Examples
     --------
@@ -106,13 +106,13 @@ def _spec() -> Specification:
                     name="property_name",
                     type_names=["string"],
                     optional=False,
-                    document=r"""Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs".""",
+                    document=r"""Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs", "step_id_from_harmonic_index".""",
                 ),
                 2: PinSpecification(
                     name="property_identifier",
-                    type_names=["int32"],
+                    type_names=["int32", "scoping"],
                     optional=True,
-                    document=r"""Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping.""",
+                    document=r"""Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping, for "step_id_from_harmonic_index" : the harmonic index.""",
                 ),
                 3: PinSpecification(
                     name="property_identifier_2",
@@ -126,7 +126,7 @@ def _spec() -> Specification:
                     name="property",
                     type_names=["double", "field", "scoping"],
                     optional=False,
-                    document=r"""Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", and a Field otherwise.""",
+                    document=r"""Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", an int for "step_id_from_harmonic_index" and a Field otherwise.""",
                 ),
             },
         )
@@ -238,7 +238,7 @@ def time_freq_support(self) -> Input:
     def property_name(self) -> Input:
         r"""Allows to connect property_name input to the operator.
 
-        Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs".
+        Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs", "step_id_from_harmonic_index".
 
         Returns
         -------
@@ -259,7 +259,7 @@ def property_name(self) -> Input:
     def property_identifier(self) -> Input:
         r"""Allows to connect property_identifier input to the operator.
 
-        Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping.
+        Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping, for "step_id_from_harmonic_index" : the harmonic index.
 
         Returns
         -------

src/ansys/dpf/core/operators/metadata/time_freq_support_get_attribute.py

@@ -156,6 +156,8 @@ class accu_eqv_creep_strain(Operator):
         If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
     shell_layer: int, optional
         If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+    extend_to_mid_nodes: bool, optional
+        Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True
 
     Returns
     -------
@@ -191,6 +193,8 @@ class accu_eqv_creep_strain(Operator):
     >>> op.inputs.split_shells.connect(my_split_shells)
     >>> my_shell_layer = int()
     >>> op.inputs.shell_layer.connect(my_shell_layer)
+    >>> my_extend_to_mid_nodes = bool()
+    >>> op.inputs.extend_to_mid_nodes.connect(my_extend_to_mid_nodes)
 
     >>> # Instantiate operator and connect inputs in one line
     >>> op = dpf.operators.result.accu_eqv_creep_strain(
@@ -205,6 +209,7 @@ class accu_eqv_creep_strain(Operator):
     ...     read_beams=my_read_beams,
     ...     split_shells=my_split_shells,
     ...     shell_layer=my_shell_layer,
+    ...     extend_to_mid_nodes=my_extend_to_mid_nodes,
     ... )
 
     >>> # Get output data
@@ -224,6 +229,7 @@ def __init__(
         read_beams=None,
         split_shells=None,
         shell_layer=None,
+        extend_to_mid_nodes=None,
         config=None,
         server=None,
     ):
@@ -252,6 +258,8 @@ def __init__(
             self.inputs.split_shells.connect(split_shells)
         if shell_layer is not None:
             self.inputs.shell_layer.connect(shell_layer)
+        if extend_to_mid_nodes is not None:
+            self.inputs.extend_to_mid_nodes.connect(extend_to_mid_nodes)
 
     @staticmethod
     def _spec() -> Specification:
@@ -446,6 +454,12 @@ def _spec() -> Specification:
                     optional=True,
                     document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
                 ),
+                28: PinSpecification(
+                    name="extend_to_mid_nodes",
+                    type_names=["bool"],
+                    optional=True,
+                    document=r"""Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True""",
+                ),
             },
             map_output_pin_spec={
                 0: PinSpecification(
@@ -532,6 +546,8 @@ class InputsAccuEqvCreepStrain(_Inputs):
     >>> op.inputs.split_shells.connect(my_split_shells)
     >>> my_shell_layer = int()
     >>> op.inputs.shell_layer.connect(my_shell_layer)
+    >>> my_extend_to_mid_nodes = bool()
+    >>> op.inputs.extend_to_mid_nodes.connect(my_extend_to_mid_nodes)
     """
 
     def __init__(self, op: Operator):
@@ -578,6 +594,10 @@ def __init__(self, op: Operator):
             accu_eqv_creep_strain._spec().input_pin(27), 27, op, -1
         )
         self._inputs.append(self._shell_layer)
+        self._extend_to_mid_nodes = Input(
+            accu_eqv_creep_strain._spec().input_pin(28), 28, op, -1
+        )
+        self._inputs.append(self._extend_to_mid_nodes)
 
     @property
     def time_scoping(self) -> Input:
@@ -810,6 +830,27 @@ def shell_layer(self) -> Input:
         """
         return self._shell_layer
 
+    @property
+    def extend_to_mid_nodes(self) -> Input:
+        r"""Allows to connect extend_to_mid_nodes input to the operator.
+
+        Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True
+
+        Returns
+        -------
+        input:
+            An Input instance for this pin.
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.result.accu_eqv_creep_strain()
+        >>> op.inputs.extend_to_mid_nodes.connect(my_extend_to_mid_nodes)
+        >>> # or
+        >>> op.inputs.extend_to_mid_nodes(my_extend_to_mid_nodes)
+        """
+        return self._extend_to_mid_nodes
+
 
 class OutputsAccuEqvCreepStrain(_Outputs):
     """Intermediate class used to get outputs from

src/ansys/dpf/core/operators/result/accu_eqv_creep_strain.py

@@ -156,6 +156,8 @@ class accu_eqv_plastic_strain(Operator):
         If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
     shell_layer: int, optional
         If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+    extend_to_mid_nodes: bool, optional
+        Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True
 
     Returns
     -------
@@ -191,6 +193,8 @@ class accu_eqv_plastic_strain(Operator):
     >>> op.inputs.split_shells.connect(my_split_shells)
     >>> my_shell_layer = int()
     >>> op.inputs.shell_layer.connect(my_shell_layer)
+    >>> my_extend_to_mid_nodes = bool()
+    >>> op.inputs.extend_to_mid_nodes.connect(my_extend_to_mid_nodes)
 
     >>> # Instantiate operator and connect inputs in one line
     >>> op = dpf.operators.result.accu_eqv_plastic_strain(
@@ -205,6 +209,7 @@ class accu_eqv_plastic_strain(Operator):
     ...     read_beams=my_read_beams,
     ...     split_shells=my_split_shells,
     ...     shell_layer=my_shell_layer,
+    ...     extend_to_mid_nodes=my_extend_to_mid_nodes,
     ... )
 
     >>> # Get output data
@@ -224,6 +229,7 @@ def __init__(
         read_beams=None,
         split_shells=None,
         shell_layer=None,
+        extend_to_mid_nodes=None,
         config=None,
         server=None,
     ):
@@ -252,6 +258,8 @@ def __init__(
             self.inputs.split_shells.connect(split_shells)
         if shell_layer is not None:
             self.inputs.shell_layer.connect(shell_layer)
+        if extend_to_mid_nodes is not None:
+            self.inputs.extend_to_mid_nodes.connect(extend_to_mid_nodes)
 
     @staticmethod
     def _spec() -> Specification:
@@ -446,6 +454,12 @@ def _spec() -> Specification:
                     optional=True,
                     document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
                 ),
+                28: PinSpecification(
+                    name="extend_to_mid_nodes",
+                    type_names=["bool"],
+                    optional=True,
+                    document=r"""Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True""",
+                ),
             },
             map_output_pin_spec={
                 0: PinSpecification(
@@ -532,6 +546,8 @@ class InputsAccuEqvPlasticStrain(_Inputs):
     >>> op.inputs.split_shells.connect(my_split_shells)
     >>> my_shell_layer = int()
     >>> op.inputs.shell_layer.connect(my_shell_layer)
+    >>> my_extend_to_mid_nodes = bool()
+    >>> op.inputs.extend_to_mid_nodes.connect(my_extend_to_mid_nodes)
     """
 
     def __init__(self, op: Operator):
@@ -578,6 +594,10 @@ def __init__(self, op: Operator):
             accu_eqv_plastic_strain._spec().input_pin(27), 27, op, -1
         )
         self._inputs.append(self._shell_layer)
+        self._extend_to_mid_nodes = Input(
+            accu_eqv_plastic_strain._spec().input_pin(28), 28, op, -1
+        )
+        self._inputs.append(self._extend_to_mid_nodes)
 
     @property
     def time_scoping(self) -> Input:
@@ -810,6 +830,27 @@ def shell_layer(self) -> Input:
         """
         return self._shell_layer
 
+    @property
+    def extend_to_mid_nodes(self) -> Input:
+        r"""Allows to connect extend_to_mid_nodes input to the operator.
+
+        Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True
+
+        Returns
+        -------
+        input:
+            An Input instance for this pin.
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.result.accu_eqv_plastic_strain()
+        >>> op.inputs.extend_to_mid_nodes.connect(my_extend_to_mid_nodes)
+        >>> # or
+        >>> op.inputs.extend_to_mid_nodes(my_extend_to_mid_nodes)
+        """
+        return self._extend_to_mid_nodes
+
 
 class OutputsAccuEqvPlasticStrain(_Outputs):
     """Intermediate class used to get outputs from

src/ansys/dpf/core/operators/result/accu_eqv_plastic_strain.py

@@ -164,6 +164,8 @@ class contact_fluid_penetration_pressure(Operator):
         If true, this pin forces the results to be split by element shape, indicated by the presence of the 'elshape' label in the output. If false, the results for all elements shapes are combined. Default value is false if averaging is not required and true if averaging is required.
     shell_layer: int, optional
         If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.
+    extend_to_mid_nodes: bool, optional
+        Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True
 
     Returns
     -------
@@ -207,6 +209,8 @@ class contact_fluid_penetration_pressure(Operator):
     >>> op.inputs.split_shells.connect(my_split_shells)
     >>> my_shell_layer = int()
     >>> op.inputs.shell_layer.connect(my_shell_layer)
+    >>> my_extend_to_mid_nodes = bool()
+    >>> op.inputs.extend_to_mid_nodes.connect(my_extend_to_mid_nodes)
 
     >>> # Instantiate operator and connect inputs in one line
     >>> op = dpf.operators.result.contact_fluid_penetration_pressure(
@@ -225,6 +229,7 @@ class contact_fluid_penetration_pressure(Operator):
     ...     read_beams=my_read_beams,
     ...     split_shells=my_split_shells,
     ...     shell_layer=my_shell_layer,
+    ...     extend_to_mid_nodes=my_extend_to_mid_nodes,
     ... )
 
     >>> # Get output data
@@ -248,6 +253,7 @@ def __init__(
         read_beams=None,
         split_shells=None,
         shell_layer=None,
+        extend_to_mid_nodes=None,
         config=None,
         server=None,
     ):
@@ -284,6 +290,8 @@ def __init__(
             self.inputs.split_shells.connect(split_shells)
         if shell_layer is not None:
             self.inputs.shell_layer.connect(shell_layer)
+        if extend_to_mid_nodes is not None:
+            self.inputs.extend_to_mid_nodes.connect(extend_to_mid_nodes)
 
     @staticmethod
     def _spec() -> Specification:
@@ -502,6 +510,12 @@ def _spec() -> Specification:
                     optional=True,
                     document=r"""If connected, this pin allows you to extract the result only on the selected shell layer(s). The available values are: 0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid.""",
                 ),
+                28: PinSpecification(
+                    name="extend_to_mid_nodes",
+                    type_names=["bool"],
+                    optional=True,
+                    document=r"""Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True""",
+                ),
             },
             map_output_pin_spec={
                 0: PinSpecification(
@@ -596,6 +610,8 @@ class InputsContactFluidPenetrationPressure(_Inputs):
     >>> op.inputs.split_shells.connect(my_split_shells)
     >>> my_shell_layer = int()
     >>> op.inputs.shell_layer.connect(my_shell_layer)
+    >>> my_extend_to_mid_nodes = bool()
+    >>> op.inputs.extend_to_mid_nodes.connect(my_extend_to_mid_nodes)
     """
 
     def __init__(self, op: Operator):
@@ -660,6 +676,10 @@ def __init__(self, op: Operator):
             contact_fluid_penetration_pressure._spec().input_pin(27), 27, op, -1
         )
         self._inputs.append(self._shell_layer)
+        self._extend_to_mid_nodes = Input(
+            contact_fluid_penetration_pressure._spec().input_pin(28), 28, op, -1
+        )
+        self._inputs.append(self._extend_to_mid_nodes)
 
     @property
     def time_scoping(self) -> Input:
@@ -976,6 +996,27 @@ def shell_layer(self) -> Input:
         """
         return self._shell_layer
 
+    @property
+    def extend_to_mid_nodes(self) -> Input:
+        r"""Allows to connect extend_to_mid_nodes input to the operator.
+
+        Compute mid nodes (when available) by averaging the neighbour corner nodes. Default: True
+
+        Returns
+        -------
+        input:
+            An Input instance for this pin.
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.result.contact_fluid_penetration_pressure()
+        >>> op.inputs.extend_to_mid_nodes.connect(my_extend_to_mid_nodes)
+        >>> # or
+        >>> op.inputs.extend_to_mid_nodes(my_extend_to_mid_nodes)
+        """
+        return self._extend_to_mid_nodes
+
 
 class OutputsContactFluidPenetrationPressure(_Outputs):
     """Intermediate class used to get outputs from