Update generated code for DPF 261_daily on main (#2642)

Co-authored-by: PProfizi <[email protected]>

Author: pyansys-ci-bot

doc/source/_static/dpf_operators.html

@@ -26,18 +26,18 @@ class force_summation(Operator):
     ----------
     time_scoping: Scoping, optional
         default = all time steps
-    nodal_scoping: Scoping, optional
-        Nodal Scoping. Set of nodes in which elemental contribution forces will be accumulated (default = all nodes)
-    elemental_scoping: Scoping, optional
-        Elemental Scoping. Set of elements contributing to the force calcuation. (default = all elements)
+    nodal_scoping: Scoping or ScopingsContainer, optional
+        Nodal Scoping or Scopings Container with a single label. Set of nodes in which elemental contribution forces will be accumulated (default = all nodes)
+    elemental_scoping: Scoping or ScopingsContainer, optional
+        Elemental Scoping or Scopings Container with a single label. Set of elements contributing to the force calculation. (default = all elements)
     streams_container: StreamsContainer, optional
         Streams container. Optional if using data sources.
     data_sources: DataSources
         Data sources. Optional if using a streams container.
     force_type: int, optional
-        Type of force to be processed (0 - default: Total forces (static, damping, and inertia)., 1: Static forces, 2: Damping forces, 3: Inertia forces)
-    spoint: Field, optional
-        Coordinate field of a point for moment summations. Defaults to (0,0,0).
+        Type of force to be processed (0: Total forces (static, damping, and inertia)., 1 (default): Static forces, 2: Damping forces, 3: Inertia forces)
+    spoint: Field or FieldsContainer, optional
+        Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0).
 
     Returns
     -------
@@ -139,15 +139,15 @@ def _spec() -> Specification:
                 ),
                 1: PinSpecification(
                     name="nodal_scoping",
-                    type_names=["scoping"],
+                    type_names=["scoping", "scopings_container"],
                     optional=True,
-                    document=r"""Nodal Scoping. Set of nodes in which elemental contribution forces will be accumulated (default = all nodes)""",
+                    document=r"""Nodal Scoping or Scopings Container with a single label. Set of nodes in which elemental contribution forces will be accumulated (default = all nodes)""",
                 ),
                 2: PinSpecification(
                     name="elemental_scoping",
-                    type_names=["scoping"],
+                    type_names=["scoping", "scopings_container"],
                     optional=True,
-                    document=r"""Elemental Scoping. Set of elements contributing to the force calcuation. (default = all elements)""",
+                    document=r"""Elemental Scoping or Scopings Container with a single label. Set of elements contributing to the force calculation. (default = all elements)""",
                 ),
                 3: PinSpecification(
                     name="streams_container",
@@ -165,13 +165,13 @@ def _spec() -> Specification:
                     name="force_type",
                     type_names=["int32"],
                     optional=True,
-                    document=r"""Type of force to be processed (0 - default: Total forces (static, damping, and inertia)., 1: Static forces, 2: Damping forces, 3: Inertia forces)""",
+                    document=r"""Type of force to be processed (0: Total forces (static, damping, and inertia)., 1 (default): Static forces, 2: Damping forces, 3: Inertia forces)""",
                 ),
                 6: PinSpecification(
                     name="spoint",
-                    type_names=["field"],
+                    type_names=["field", "fields_container"],
                     optional=True,
-                    document=r"""Coordinate field of a point for moment summations. Defaults to (0,0,0).""",
+                    document=r"""Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0).""",
                 ),
             },
             map_output_pin_spec={
@@ -325,7 +325,7 @@ def time_scoping(self) -> Input:
     def nodal_scoping(self) -> Input:
         r"""Allows to connect nodal_scoping input to the operator.
 
-        Nodal Scoping. Set of nodes in which elemental contribution forces will be accumulated (default = all nodes)
+        Nodal Scoping or Scopings Container with a single label. Set of nodes in which elemental contribution forces will be accumulated (default = all nodes)
 
         Returns
         -------
@@ -346,7 +346,7 @@ def nodal_scoping(self) -> Input:
     def elemental_scoping(self) -> Input:
         r"""Allows to connect elemental_scoping input to the operator.
 
-        Elemental Scoping. Set of elements contributing to the force calcuation. (default = all elements)
+        Elemental Scoping or Scopings Container with a single label. Set of elements contributing to the force calculation. (default = all elements)
 
         Returns
         -------
@@ -409,7 +409,7 @@ def data_sources(self) -> Input:
     def force_type(self) -> Input:
         r"""Allows to connect force_type input to the operator.
 
-        Type of force to be processed (0 - default: Total forces (static, damping, and inertia)., 1: Static forces, 2: Damping forces, 3: Inertia forces)
+        Type of force to be processed (0: Total forces (static, damping, and inertia)., 1 (default): Static forces, 2: Damping forces, 3: Inertia forces)
 
         Returns
         -------
@@ -430,7 +430,7 @@ def force_type(self) -> Input:
     def spoint(self) -> Input:
         r"""Allows to connect spoint input to the operator.
 
-        Coordinate field of a point for moment summations. Defaults to (0,0,0).
+        Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0).
 
         Returns
         -------

src/ansys/dpf/core/operators/averaging/force_summation.py

@@ -23,17 +23,17 @@ class force_summation_psd(Operator):
 
     Parameters
     ----------
-    nodal_scoping: Scoping, optional
-        Nodal Scoping. Set of nodes in which elemental contribution forces will be accumulated. Defaults to all nodes.
-    elemental_scoping: Scoping, optional
-        Elemental Scoping. Set of elements contributing to the force calculation. Defaults to all elements.
+    nodal_scoping: Scoping or ScopingsContainer, optional
+        Nodal scoping or scopings container with a single label. Set of nodes in which elemental contribution forces will be accumulated. Defaults to all nodes.
+    elemental_scoping: Scoping or ScopingsContainer, optional
+        Elemental scoping or scopings container with a single label. Set of elements contributing to the force calculation. Defaults to all elements.
     streams: StreamsContainer, optional
         Streams container for RST and PSD files (optional if using data sources). The operator supports both a single RST file and two separate RST files. See data sources pin specifications for details on how to define the streams for both cases.
     data_sources: DataSources
         Data sources containing RST and PSD files (optional if using a streams container). The operator supports both a single RST file (containing both modal and PSD results) and two separate RST files (one for modal and one for PSD analyses).The data source containing modal results must be defined as an upstream data source.If using a single RST file for PSD and modal analysis, the RST file must be in an upstream data source.If using two separate RST files, only the modal RST must be in an upstream data source.
-    spoint: Field, optional
-        Coordinate field of a point for moment summations. Defaults to (0,0,0).
-    abs_rel_key: Field, optional
+    spoint: Field or FieldsContainer, optional
+        Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0).
+    abs_rel_key: int, optional
         Key to select the type of response: 0 for relative response (default) or 1 for absolute response.
     signif: float, optional
         Significance threshold, defaults to 0.0001. Any mode with a significance level above this value will be included in the combination.The significance level is defined as the modal covariance matrix term, divided by the maximum modal covariance matrix term.
@@ -67,7 +67,7 @@ class force_summation_psd(Operator):
     >>> op.inputs.data_sources.connect(my_data_sources)
     >>> my_spoint = dpf.Field()
     >>> op.inputs.spoint.connect(my_spoint)
-    >>> my_abs_rel_key = dpf.Field()
+    >>> my_abs_rel_key = int()
     >>> op.inputs.abs_rel_key.connect(my_abs_rel_key)
     >>> my_signif = float()
     >>> op.inputs.signif.connect(my_signif)
@@ -131,15 +131,15 @@ def _spec() -> Specification:
             map_input_pin_spec={
                 1: PinSpecification(
                     name="nodal_scoping",
-                    type_names=["scoping"],
+                    type_names=["scoping", "scopings_container"],
                     optional=True,
-                    document=r"""Nodal Scoping. Set of nodes in which elemental contribution forces will be accumulated. Defaults to all nodes.""",
+                    document=r"""Nodal scoping or scopings container with a single label. Set of nodes in which elemental contribution forces will be accumulated. Defaults to all nodes.""",
                 ),
                 2: PinSpecification(
                     name="elemental_scoping",
-                    type_names=["scoping"],
+                    type_names=["scoping", "scopings_container"],
                     optional=True,
-                    document=r"""Elemental Scoping. Set of elements contributing to the force calculation. Defaults to all elements.""",
+                    document=r"""Elemental scoping or scopings container with a single label. Set of elements contributing to the force calculation. Defaults to all elements.""",
                 ),
                 3: PinSpecification(
                     name="streams",
@@ -155,13 +155,13 @@ def _spec() -> Specification:
                 ),
                 6: PinSpecification(
                     name="spoint",
-                    type_names=["field"],
+                    type_names=["field", "fields_container"],
                     optional=True,
-                    document=r"""Coordinate field of a point for moment summations. Defaults to (0,0,0).""",
+                    document=r"""Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0).""",
                 ),
                 7: PinSpecification(
                     name="abs_rel_key",
-                    type_names=["field"],
+                    type_names=["int32"],
                     optional=True,
                     document=r"""Key to select the type of response: 0 for relative response (default) or 1 for absolute response.""",
                 ),
@@ -263,7 +263,7 @@ class InputsForceSummationPsd(_Inputs):
     >>> op.inputs.data_sources.connect(my_data_sources)
     >>> my_spoint = dpf.Field()
     >>> op.inputs.spoint.connect(my_spoint)
-    >>> my_abs_rel_key = dpf.Field()
+    >>> my_abs_rel_key = int()
     >>> op.inputs.abs_rel_key.connect(my_abs_rel_key)
     >>> my_signif = float()
     >>> op.inputs.signif.connect(my_signif)
@@ -292,7 +292,7 @@ def __init__(self, op: Operator):
     def nodal_scoping(self) -> Input:
         r"""Allows to connect nodal_scoping input to the operator.
 
-        Nodal Scoping. Set of nodes in which elemental contribution forces will be accumulated. Defaults to all nodes.
+        Nodal scoping or scopings container with a single label. Set of nodes in which elemental contribution forces will be accumulated. Defaults to all nodes.
 
         Returns
         -------
@@ -313,7 +313,7 @@ def nodal_scoping(self) -> Input:
     def elemental_scoping(self) -> Input:
         r"""Allows to connect elemental_scoping input to the operator.
 
-        Elemental Scoping. Set of elements contributing to the force calculation. Defaults to all elements.
+        Elemental scoping or scopings container with a single label. Set of elements contributing to the force calculation. Defaults to all elements.
 
         Returns
         -------
@@ -376,7 +376,7 @@ def data_sources(self) -> Input:
     def spoint(self) -> Input:
         r"""Allows to connect spoint input to the operator.
 
-        Coordinate field of a point for moment summations. Defaults to (0,0,0).
+        Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0).
 
         Returns
         -------

src/ansys/dpf/core/operators/averaging/force_summation_psd.py

@@ -22,9 +22,9 @@ class torque(Operator):
     Parameters
     ----------
     fields_container: FieldsContainer
-        fields_container
-    field: Field
-        field
+        Fields container containing the nodal forces.
+    spoint: Field or FieldsContainer
+        Field or fields container containing the summation points for each associated field on pin 0.
 
     Returns
     -------
@@ -40,27 +40,41 @@ class torque(Operator):
     >>> # Make input connections
     >>> my_fields_container = dpf.FieldsContainer()
     >>> op.inputs.fields_container.connect(my_fields_container)
-    >>> my_field = dpf.Field()
-    >>> op.inputs.field.connect(my_field)
+    >>> my_spoint = dpf.Field()
+    >>> op.inputs.spoint.connect(my_spoint)
 
     >>> # Instantiate operator and connect inputs in one line
     >>> op = dpf.operators.result.torque(
     ...     fields_container=my_fields_container,
-    ...     field=my_field,
+    ...     spoint=my_spoint,
     ... )
 
     >>> # Get output data
     >>> result_fields_container = op.outputs.fields_container()
     """
 
-    def __init__(self, fields_container=None, field=None, config=None, server=None):
+    def __init__(
+        self,
+        fields_container=None,
+        spoint=None,
+        config=None,
+        server=None,
+        field=None,
+    ):
         super().__init__(name="torque", config=config, server=server)
         self._inputs = InputsTorque(self)
         self._outputs = OutputsTorque(self)
         if fields_container is not None:
             self.inputs.fields_container.connect(fields_container)
-        if field is not None:
-            self.inputs.field.connect(field)
+        if spoint is not None:
+            self.inputs.spoint.connect(spoint)
+        elif field is not None:
+            warn(
+                DeprecationWarning(
+                    f'Operator torque: Input name "field" is deprecated in favor of "spoint".'
+                )
+            )
+            self.inputs.spoint.connect(field)
 
     @staticmethod
     def _spec() -> Specification:
@@ -73,13 +87,14 @@ def _spec() -> Specification:
                     name="fields_container",
                     type_names=["fields_container"],
                     optional=False,
-                    document=r"""fields_container""",
+                    document=r"""Fields container containing the nodal forces.""",
                 ),
                 1: PinSpecification(
-                    name="field",
-                    type_names=["field"],
+                    name="spoint",
+                    type_names=["field", "fields_container"],
                     optional=False,
-                    document=r"""field""",
+                    document=r"""Field or fields container containing the summation points for each associated field on pin 0.""",
+                    aliases=["field"],
                 ),
             },
             map_output_pin_spec={
@@ -147,22 +162,22 @@ class InputsTorque(_Inputs):
     >>> op = dpf.operators.result.torque()
     >>> my_fields_container = dpf.FieldsContainer()
     >>> op.inputs.fields_container.connect(my_fields_container)
-    >>> my_field = dpf.Field()
-    >>> op.inputs.field.connect(my_field)
+    >>> my_spoint = dpf.Field()
+    >>> op.inputs.spoint.connect(my_spoint)
     """
 
     def __init__(self, op: Operator):
         super().__init__(torque._spec().inputs, op)
         self._fields_container = Input(torque._spec().input_pin(0), 0, op, -1)
         self._inputs.append(self._fields_container)
-        self._field = Input(torque._spec().input_pin(1), 1, op, -1)
-        self._inputs.append(self._field)
+        self._spoint = Input(torque._spec().input_pin(1), 1, op, -1)
+        self._inputs.append(self._spoint)
 
     @property
     def fields_container(self) -> Input:
         r"""Allows to connect fields_container input to the operator.
 
-        fields_container
+        Fields container containing the nodal forces.
 
         Returns
         -------
@@ -180,10 +195,10 @@ def fields_container(self) -> Input:
         return self._fields_container
 
     @property
-    def field(self) -> Input:
-        r"""Allows to connect field input to the operator.
+    def spoint(self) -> Input:
+        r"""Allows to connect spoint input to the operator.
 
-        field
+        Field or fields container containing the summation points for each associated field on pin 0.
 
         Returns
         -------
@@ -194,11 +209,23 @@ def field(self) -> Input:
         --------
         >>> from ansys.dpf import core as dpf
         >>> op = dpf.operators.result.torque()
-        >>> op.inputs.field.connect(my_field)
+        >>> op.inputs.spoint.connect(my_spoint)
         >>> # or
-        >>> op.inputs.field(my_field)
+        >>> op.inputs.spoint(my_spoint)
         """
-        return self._field
+        return self._spoint
+
+    def __getattr__(self, name):
+        if name in ["field"]:
+            warn(
+                DeprecationWarning(
+                    f'Operator torque: Input name "{name}" is deprecated in favor of "spoint".'
+                )
+            )
+            return self.spoint
+        raise AttributeError(
+            f"'{self.__class__.__name__}' object has no attribute '{name}'."
+        )
 
 
 class OutputsTorque(_Outputs):