update generated code (#2097)

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

Author: pyansys-ci-bot

doc/source/_static/dpf_operators.html

@@ -34,9 +34,9 @@ class elemental_difference_fc(Operator):
         correspond to the one of the fields
         container.
     collapse_shell_layers : bool, optional
-        The maximum elemental difference is taken
-        through the different shell layers if
-        true (default is false).
+        If true, the data across different shell
+        layers is averaged as well (default
+        is false).
 
     Returns
     -------
@@ -133,9 +133,9 @@ def _spec():
                     name="collapse_shell_layers",
                     type_names=["bool"],
                     optional=True,
-                    document="""The maximum elemental difference is taken
-        through the different shell layers if
-        true (default is false).""",
+                    document="""If true, the data across different shell
+        layers is averaged as well (default
+        is false).""",
                 ),
             },
             map_output_pin_spec={
@@ -286,9 +286,9 @@ def scoping(self):
     def collapse_shell_layers(self):
         """Allows to connect collapse_shell_layers input to the operator.
 
-        The maximum elemental difference is taken
-        through the different shell layers if
-        true (default is false).
+        If true, the data across different shell
+        layers is averaged as well (default
+        is false).
 
         Parameters
         ----------

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

@@ -35,10 +35,9 @@ class elemental_fraction_fc(Operator):
         fraction instead of
         entity_average_fc.
     collapse_shell_layers : bool, optional
-        The elemental difference and the entity
-        average are taken through the
-        different shell layers if true
-        (default is false).
+        If true, the data across different shell
+        layers is averaged as well (default
+        is false).
 
     Returns
     -------
@@ -145,10 +144,9 @@ def _spec():
                     name="collapse_shell_layers",
                     type_names=["bool"],
                     optional=True,
-                    document="""The elemental difference and the entity
-        average are taken through the
-        different shell layers if true
-        (default is false).""",
+                    document="""If true, the data across different shell
+        layers is averaged as well (default
+        is false).""",
                 ),
             },
             map_output_pin_spec={
@@ -326,10 +324,9 @@ def denominator(self):
     def collapse_shell_layers(self):
         """Allows to connect collapse_shell_layers input to the operator.
 
-        The elemental difference and the entity
-        average are taken through the
-        different shell layers if true
-        (default is false).
+        If true, the data across different shell
+        layers is averaged as well (default
+        is false).
 
         Parameters
         ----------

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

@@ -14,27 +14,45 @@
 class elemental_mean_fc(Operator):
     """Computes the average of a multi-entity container of fields,
     (ElementalNodal -> Elemental), (NodalElemental -> Nodal). If the
-    input fields are mixed shell/solid and collapseShellLayers is not
-    specified, then the fields are split by element shape and the
-    output fields container has an elshape label.
+    input fields are mixed shell/solid and collapseShellLayers is
+    false, then the fields could be split by element shape and the
+    output fields container would have an elshape label depending on
+    the e_shell_layer and merge_solid_shell inputs (if e_shell_layer
+    is not specified, the fields are split; if it is specified, the
+    fields can be split based on merge_solid_shell).If
+    collapseShellLayers is true, all available shell layers are
+    collapsed and shells and solid fields are always merged.
 
     Parameters
     ----------
     fields_container : FieldsContainer
     collapse_shell_layers : bool, optional
-        If true, shell layers are averaged as well
-        (default is false).
+        If true, the data across different shell
+        layers is averaged as well (default
+        is false).
     force_averaging : bool, optional
         If true you average, if false you just sum.
-    scoping : Scoping, optional
+    scoping : Scoping or ScopingsContainer, optional
         Average only on these elements. if it is a
         scoping container, the label must
         correspond to the one of the fields
-        containers.
-    abstract_meshed_region : MeshedRegion, optional
+        container.
+    abstract_meshed_region : MeshedRegion or MeshesContainer, optional
         The mesh region in this pin is used to
         perform the averaging. it is used if
         there is no fields support.
+    merge_solid_shell : bool, optional
+        For shell/solid mixed fields, group in the
+        same field all solids and shells
+        (false by default). this pin only has
+        an effect when collapse_shell_layers
+        is false and a value for
+        e_shell_layer is provided.
+    e_shell_layer : int, optional
+        0: top, 1: bottom, 2: bottomtop, 3: mid, 4:
+        bottomtopmid. this pin only has an
+        effect when collapse_shell_layers is
+        false.
 
     Returns
     -------
@@ -58,6 +76,10 @@ class elemental_mean_fc(Operator):
     >>> op.inputs.scoping.connect(my_scoping)
     >>> my_abstract_meshed_region = dpf.MeshedRegion()
     >>> op.inputs.abstract_meshed_region.connect(my_abstract_meshed_region)
+    >>> my_merge_solid_shell = bool()
+    >>> op.inputs.merge_solid_shell.connect(my_merge_solid_shell)
+    >>> my_e_shell_layer = int()
+    >>> op.inputs.e_shell_layer.connect(my_e_shell_layer)
 
     >>> # Instantiate operator and connect inputs in one line
     >>> op = dpf.operators.averaging.elemental_mean_fc(
@@ -66,6 +88,8 @@ class elemental_mean_fc(Operator):
     ...     force_averaging=my_force_averaging,
     ...     scoping=my_scoping,
     ...     abstract_meshed_region=my_abstract_meshed_region,
+    ...     merge_solid_shell=my_merge_solid_shell,
+    ...     e_shell_layer=my_e_shell_layer,
     ... )
 
     >>> # Get output data
@@ -79,6 +103,8 @@ def __init__(
         force_averaging=None,
         scoping=None,
         abstract_meshed_region=None,
+        merge_solid_shell=None,
+        e_shell_layer=None,
         config=None,
         server=None,
     ):
@@ -95,15 +121,25 @@ def __init__(
             self.inputs.scoping.connect(scoping)
         if abstract_meshed_region is not None:
             self.inputs.abstract_meshed_region.connect(abstract_meshed_region)
+        if merge_solid_shell is not None:
+            self.inputs.merge_solid_shell.connect(merge_solid_shell)
+        if e_shell_layer is not None:
+            self.inputs.e_shell_layer.connect(e_shell_layer)
 
     @staticmethod
     def _spec():
         description = """Computes the average of a multi-entity container of fields,
             (ElementalNodal -> Elemental), (NodalElemental -> Nodal).
             If the input fields are mixed shell/solid and
-            collapseShellLayers is not specified, then the fields are
-            split by element shape and the output fields container has
-            an elshape label."""
+            collapseShellLayers is false, then the fields could be
+            split by element shape and the output fields container
+            would have an elshape label depending on the e_shell_layer
+            and merge_solid_shell inputs (if e_shell_layer is not
+            specified, the fields are split; if it is specified, the
+            fields can be split based on merge_solid_shell).If
+            collapseShellLayers is true, all available shell layers
+            are collapsed and shells and solid fields are always
+            merged."""
         spec = Specification(
             description=description,
             map_input_pin_spec={
@@ -117,8 +153,9 @@ def _spec():
                     name="collapse_shell_layers",
                     type_names=["bool"],
                     optional=True,
-                    document="""If true, shell layers are averaged as well
-        (default is false).""",
+                    document="""If true, the data across different shell
+        layers is averaged as well (default
+        is false).""",
                 ),
                 2: PinSpecification(
                     name="force_averaging",
@@ -128,21 +165,41 @@ def _spec():
                 ),
                 3: PinSpecification(
                     name="scoping",
-                    type_names=["scoping"],
+                    type_names=["scoping", "scopings_container"],
                     optional=True,
                     document="""Average only on these elements. if it is a
         scoping container, the label must
         correspond to the one of the fields
-        containers.""",
+        container.""",
                 ),
                 4: PinSpecification(
                     name="abstract_meshed_region",
-                    type_names=["abstract_meshed_region"],
+                    type_names=["abstract_meshed_region", "meshes_container"],
                     optional=True,
                     document="""The mesh region in this pin is used to
         perform the averaging. it is used if
         there is no fields support.""",
                 ),
+                26: PinSpecification(
+                    name="merge_solid_shell",
+                    type_names=["bool"],
+                    optional=True,
+                    document="""For shell/solid mixed fields, group in the
+        same field all solids and shells
+        (false by default). this pin only has
+        an effect when collapse_shell_layers
+        is false and a value for
+        e_shell_layer is provided.""",
+                ),
+                27: PinSpecification(
+                    name="e_shell_layer",
+                    type_names=["int32"],
+                    optional=True,
+                    document="""0: top, 1: bottom, 2: bottomtop, 3: mid, 4:
+        bottomtopmid. this pin only has an
+        effect when collapse_shell_layers is
+        false.""",
+                ),
             },
             map_output_pin_spec={
                 0: PinSpecification(
@@ -210,6 +267,10 @@ class InputsElementalMeanFc(_Inputs):
     >>> op.inputs.scoping.connect(my_scoping)
     >>> my_abstract_meshed_region = dpf.MeshedRegion()
     >>> op.inputs.abstract_meshed_region.connect(my_abstract_meshed_region)
+    >>> my_merge_solid_shell = bool()
+    >>> op.inputs.merge_solid_shell.connect(my_merge_solid_shell)
+    >>> my_e_shell_layer = int()
+    >>> op.inputs.e_shell_layer.connect(my_e_shell_layer)
     """
 
     def __init__(self, op: Operator):
@@ -230,6 +291,12 @@ def __init__(self, op: Operator):
             elemental_mean_fc._spec().input_pin(4), 4, op, -1
         )
         self._inputs.append(self._abstract_meshed_region)
+        self._merge_solid_shell = Input(
+            elemental_mean_fc._spec().input_pin(26), 26, op, -1
+        )
+        self._inputs.append(self._merge_solid_shell)
+        self._e_shell_layer = Input(elemental_mean_fc._spec().input_pin(27), 27, op, -1)
+        self._inputs.append(self._e_shell_layer)
 
     @property
     def fields_container(self):
@@ -253,8 +320,9 @@ def fields_container(self):
     def collapse_shell_layers(self):
         """Allows to connect collapse_shell_layers input to the operator.
 
-        If true, shell layers are averaged as well
-        (default is false).
+        If true, the data across different shell
+        layers is averaged as well (default
+        is false).
 
         Parameters
         ----------
@@ -297,11 +365,11 @@ def scoping(self):
         Average only on these elements. if it is a
         scoping container, the label must
         correspond to the one of the fields
-        containers.
+        container.
 
         Parameters
         ----------
-        my_scoping : Scoping
+        my_scoping : Scoping or ScopingsContainer
 
         Examples
         --------
@@ -323,7 +391,7 @@ def abstract_meshed_region(self):
 
         Parameters
         ----------
-        my_abstract_meshed_region : MeshedRegion
+        my_abstract_meshed_region : MeshedRegion or MeshesContainer
 
         Examples
         --------
@@ -335,6 +403,54 @@ def abstract_meshed_region(self):
         """
         return self._abstract_meshed_region
 
+    @property
+    def merge_solid_shell(self):
+        """Allows to connect merge_solid_shell input to the operator.
+
+        For shell/solid mixed fields, group in the
+        same field all solids and shells
+        (false by default). this pin only has
+        an effect when collapse_shell_layers
+        is false and a value for
+        e_shell_layer is provided.
+
+        Parameters
+        ----------
+        my_merge_solid_shell : bool
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.averaging.elemental_mean_fc()
+        >>> op.inputs.merge_solid_shell.connect(my_merge_solid_shell)
+        >>> # or
+        >>> op.inputs.merge_solid_shell(my_merge_solid_shell)
+        """
+        return self._merge_solid_shell
+
+    @property
+    def e_shell_layer(self):
+        """Allows to connect e_shell_layer input to the operator.
+
+        0: top, 1: bottom, 2: bottomtop, 3: mid, 4:
+        bottomtopmid. this pin only has an
+        effect when collapse_shell_layers is
+        false.
+
+        Parameters
+        ----------
+        my_e_shell_layer : int
+
+        Examples
+        --------
+        >>> from ansys.dpf import core as dpf
+        >>> op = dpf.operators.averaging.elemental_mean_fc()
+        >>> op.inputs.e_shell_layer.connect(my_e_shell_layer)
+        >>> # or
+        >>> op.inputs.e_shell_layer(my_e_shell_layer)
+        """
+        return self._e_shell_layer
+
 
 class OutputsElementalMeanFc(_Outputs):
     """Intermediate class used to get outputs from