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

Co-authored-by: PProfizi <100710998+PProfizi@users.noreply.github.com>

Author: pyansys-ci-bot

doc/source/_static/dpf_operators.html

@@ -26,7 +26,7 @@ class abc_weightings(Operator):
     Inputs
     ------
     fields_container: FieldsContainer
-        data to be weighted in dB units.
+        data to be weighted in dB units equipped with cumulative ids in the scoping.
     weighting_type: int
         if this pin is set to 0, the A-weighting is computed, 1 the B-weigting is computed and 2 the C-weightings is computed.
     shape_by_tf_scoping: bool
@@ -95,7 +95,7 @@ def _spec() -> Specification:
                     name="fields_container",
                     type_names=["fields_container"],
                     optional=False,
-                    document=r"""data to be weighted in dB units.""",
+                    document=r"""data to be weighted in dB units equipped with cumulative ids in the scoping.""",
                 ),
                 1: PinSpecification(
                     name="weighting_type",
@@ -200,7 +200,7 @@ def __init__(self, op: Operator):
     def fields_container(self) -> Input[FieldsContainer]:
         r"""Allows to connect fields_container input to the operator.
 
-        data to be weighted in dB units.
+        data to be weighted in dB units equipped with cumulative ids in the scoping.
 
         Returns
         -------

src/ansys/dpf/core/operators/filter/abc_weightings.py

@@ -21,18 +21,19 @@
 
 
 class absolute_value_by_component(Operator):
-    r"""Compute the absolute value of each data value of the input field, no
-    norm performed.
+    r"""Computes the absolute value of each data value in the input field
+    component-wise, without performing vector norm operations.
 
 
     Inputs
     ------
     field: Field or FieldsContainer or float
-        field or fields container with only one field is expected
+        Field, fields container, or numeric data for which to compute absolute values
 
     Outputs
     -------
     field: Field
+        Field with absolute values applied to each component
 
     Examples
     --------
@@ -68,8 +69,8 @@ def __init__(self, field=None, config=None, server=None):
 
     @staticmethod
     def _spec() -> Specification:
-        description = r"""Compute the absolute value of each data value of the input field, no
-norm performed.
+        description = r"""Computes the absolute value of each data value in the input field
+component-wise, without performing vector norm operations.
 """
         spec = Specification(
             description=description,
@@ -83,15 +84,15 @@ def _spec() -> Specification:
                         "vector<double>",
                     ],
                     optional=False,
-                    document=r"""field or fields container with only one field is expected""",
+                    document=r"""Field, fields container, or numeric data for which to compute absolute values""",
                 ),
             },
             map_output_pin_spec={
                 0: PinSpecification(
                     name="field",
                     type_names=["field"],
                     optional=False,
-                    document=r"""""",
+                    document=r"""Field with absolute values applied to each component""",
                 ),
             },
         )
@@ -166,7 +167,7 @@ def __init__(self, op: Operator):
     def field(self) -> Input[Field | FieldsContainer | float]:
         r"""Allows to connect field input to the operator.
 
-        field or fields container with only one field is expected
+        Field, fields container, or numeric data for which to compute absolute values
 
         Returns
         -------
@@ -207,6 +208,8 @@ def __init__(self, op: Operator):
     def field(self) -> Output[Field]:
         r"""Allows to get field output of the operator
 
+        Field with absolute values applied to each component
+
         Returns
         -------
         output:

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

@@ -20,18 +20,19 @@
 
 
 class absolute_value_by_component_fc(Operator):
-    r"""Compute the absolute value of each data value of the input field, no
-    norm performed.
+    r"""Computes the absolute value of each data value in the input field
+    component-wise, without performing vector norm operations.
 
 
     Inputs
     ------
     fields_container: FieldsContainer
-        field or fields container with only one field is expected
+        Field, fields container, or numeric data for which to compute absolute values
 
     Outputs
     -------
     fields_container: FieldsContainer
+        Field with absolute values applied to each component
 
     Examples
     --------
@@ -67,8 +68,8 @@ def __init__(self, fields_container=None, config=None, server=None):
 
     @staticmethod
     def _spec() -> Specification:
-        description = r"""Compute the absolute value of each data value of the input field, no
-norm performed.
+        description = r"""Computes the absolute value of each data value in the input field
+component-wise, without performing vector norm operations.
 """
         spec = Specification(
             description=description,
@@ -77,15 +78,15 @@ def _spec() -> Specification:
                     name="fields_container",
                     type_names=["fields_container"],
                     optional=False,
-                    document=r"""field or fields container with only one field is expected""",
+                    document=r"""Field, fields container, or numeric data for which to compute absolute values""",
                 ),
             },
             map_output_pin_spec={
                 0: PinSpecification(
                     name="fields_container",
                     type_names=["fields_container"],
                     optional=False,
-                    document=r"""""",
+                    document=r"""Field with absolute values applied to each component""",
                 ),
             },
         )
@@ -160,7 +161,7 @@ def __init__(self, op: Operator):
     def fields_container(self) -> Input[FieldsContainer]:
         r"""Allows to connect fields_container input to the operator.
 
-        field or fields container with only one field is expected
+        Field, fields container, or numeric data for which to compute absolute values
 
         Returns
         -------
@@ -201,6 +202,8 @@ def __init__(self, op: Operator):
     def fields_container(self) -> Output[FieldsContainer]:
         r"""Allows to get fields_container output of the operator
 
+        Field with absolute values applied to each component
+
         Returns
         -------
         output:

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

@@ -38,6 +38,7 @@ class add(Operator):
     Outputs
     -------
     field: Field
+        Field containing the element-wise sum of the two input fields
 
     Examples
     --------
@@ -113,7 +114,7 @@ def _spec() -> Specification:
                     name="field",
                     type_names=["field"],
                     optional=False,
-                    document=r"""""",
+                    document=r"""Field containing the element-wise sum of the two input fields""",
                 ),
             },
         )
@@ -252,6 +253,8 @@ def __init__(self, op: Operator):
     def field(self) -> Output[Field]:
         r"""Allows to get field output of the operator
 
+        Field containing the element-wise sum of the two input fields
+
         Returns
         -------
         output:

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

@@ -34,6 +34,7 @@ class add_fc(Operator):
     Outputs
     -------
     fields_container: FieldsContainer
+        FieldsContainer with summed fields by label space
 
     Examples
     --------
@@ -109,7 +110,7 @@ def _spec() -> Specification:
                     name="fields_container",
                     type_names=["fields_container"],
                     optional=False,
-                    document=r"""""",
+                    document=r"""FieldsContainer with summed fields by label space""",
                 ),
             },
         )
@@ -246,6 +247,8 @@ def __init__(self, op: Operator):
     def fields_container(self) -> Output[FieldsContainer]:
         r"""Allows to get fields_container output of the operator
 
+        FieldsContainer with summed fields by label space
+
         Returns
         -------
         output:

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

@@ -37,6 +37,7 @@ class centroid(Operator):
     Outputs
     -------
     field: Field
+        Field with centroid calculation: fieldA*(1-factor) + fieldB*factor
 
     Examples
     --------
@@ -110,7 +111,7 @@ def _spec() -> Specification:
                     name="field",
                     type_names=["field"],
                     optional=False,
-                    document=r"""""",
+                    document=r"""Field with centroid calculation: fieldA*(1-factor) + fieldB*factor""",
                 ),
             },
         )
@@ -274,6 +275,8 @@ def __init__(self, op: Operator):
     def field(self) -> Output[Field]:
         r"""Allows to get field output of the operator
 
+        Field with centroid calculation: fieldA*(1-factor) + fieldB*factor
+
         Returns
         -------
         output:

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

@@ -29,13 +29,18 @@ class centroid_fc(Operator):
     Inputs
     ------
     fields_container: FieldsContainer
+        FieldsContainer with fields for centroid calculation
     time_freq: float
+        Time or frequency value for field selection
     step: int, optional
+        Optional step specification
     time_freq_support: TimeFreqSupport, optional
+        Optional TimeFreqSupport for field resolution
 
     Outputs
     -------
     fields_container: FieldsContainer
+        FieldsContainer with centroid calculation results at specified time/frequency
 
     Examples
     --------
@@ -103,33 +108,33 @@ def _spec() -> Specification:
                     name="fields_container",
                     type_names=["fields_container"],
                     optional=False,
-                    document=r"""""",
+                    document=r"""FieldsContainer with fields for centroid calculation""",
                 ),
                 1: PinSpecification(
                     name="time_freq",
                     type_names=["double"],
                     optional=False,
-                    document=r"""""",
+                    document=r"""Time or frequency value for field selection""",
                 ),
                 2: PinSpecification(
                     name="step",
                     type_names=["int32"],
                     optional=True,
-                    document=r"""""",
+                    document=r"""Optional step specification""",
                 ),
                 8: PinSpecification(
                     name="time_freq_support",
                     type_names=["time_freq_support"],
                     optional=True,
-                    document=r"""""",
+                    document=r"""Optional TimeFreqSupport for field resolution""",
                 ),
             },
             map_output_pin_spec={
                 0: PinSpecification(
                     name="fields_container",
                     type_names=["fields_container"],
                     optional=False,
-                    document=r"""""",
+                    document=r"""FieldsContainer with centroid calculation results at specified time/frequency""",
                 ),
             },
         )
@@ -218,6 +223,8 @@ def __init__(self, op: Operator):
     def fields_container(self) -> Input[FieldsContainer]:
         r"""Allows to connect fields_container input to the operator.
 
+        FieldsContainer with fields for centroid calculation
+
         Returns
         -------
         input:
@@ -237,6 +244,8 @@ def fields_container(self) -> Input[FieldsContainer]:
     def time_freq(self) -> Input[float]:
         r"""Allows to connect time_freq input to the operator.
 
+        Time or frequency value for field selection
+
         Returns
         -------
         input:
@@ -256,6 +265,8 @@ def time_freq(self) -> Input[float]:
     def step(self) -> Input[int]:
         r"""Allows to connect step input to the operator.
 
+        Optional step specification
+
         Returns
         -------
         input:
@@ -275,6 +286,8 @@ def step(self) -> Input[int]:
     def time_freq_support(self) -> Input[TimeFreqSupport]:
         r"""Allows to connect time_freq_support input to the operator.
 
+        Optional TimeFreqSupport for field resolution
+
         Returns
         -------
         input:
@@ -314,6 +327,8 @@ def __init__(self, op: Operator):
     def fields_container(self) -> Output[FieldsContainer]:
         r"""Allows to get fields_container output of the operator
 
+        FieldsContainer with centroid calculation results at specified time/frequency
+
         Returns
         -------
         output: