Update Operators for DPF 232 on master (#804)

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

Author: github-actions[bot]

docs/source/_static/dpf_entry.html

@@ -11,10 +11,10 @@
 
 
 class elemental_difference(Operator):
-    """Transform ElementalNodal or Nodal field into Elemental field. Each
-    elemental value is the maximum difference between the computed
-    result for all nodes in this element. Result is computed on a
-    given element scoping.
+    """Transforms an Elemental Nodal or Nodal field into an Elemental field.
+    Each elemental value is the maximum difference between the
+    computed result for all nodes in this element. The result is
+    computed on a given element scoping.
 
     Parameters
     ----------
@@ -25,9 +25,9 @@ class elemental_difference(Operator):
         Average only on these entities
     mesh : MeshedRegion, optional
     through_layers : bool, optional
-        The max elemental difference is taken through
-        the different shell layers if true
-        (default is false)
+        The maximum elemental difference is taken
+        through the different shell layers if
+        true (default is false).
 
 
     Examples
@@ -82,10 +82,10 @@ def __init__(
 
     @staticmethod
     def _spec():
-        description = """Transform ElementalNodal or Nodal field into Elemental field. Each
-            elemental value is the maximum difference between the
-            computed result for all nodes in this element. Result is
-            computed on a given element scoping."""
+        description = """Transforms an Elemental Nodal or Nodal field into an Elemental field.
+            Each elemental value is the maximum difference between the
+            computed result for all nodes in this element. The result
+            is computed on a given element scoping."""
         spec = Specification(
             description=description,
             map_input_pin_spec={
@@ -112,9 +112,9 @@ def _spec():
                     name="through_layers",
                     type_names=["bool"],
                     optional=True,
-                    document="""The max elemental difference is taken through
-        the different shell layers if true
-        (default is false)""",
+                    document="""The maximum elemental difference is taken
+        through the different shell layers if
+        true (default is false).""",
                 ),
             },
             map_output_pin_spec={
@@ -259,9 +259,9 @@ def mesh(self):
     def through_layers(self):
         """Allows to connect through_layers input to the operator.
 
-        The max elemental difference is taken through
-        the different shell layers if true
-        (default is false)
+        The maximum elemental difference is taken
+        through the different shell layers if
+        true (default is false).
 
         Parameters
         ----------

docs/source/_static/dpf_premium.html

@@ -11,30 +11,31 @@
 
 
 class elemental_difference_fc(Operator):
-    """Transform ElementalNodal or Nodal field into Elemental field. Each
-    elemental value is the maximum difference between the unaveraged
-    or averaged (depending on the input fields) computed result for
-    all nodes in this element. Result is computed on a given element
-    scoping. If the input fields are mixed shell/solid and the shells
-    layers are not asked to be collapsed, then the fields are split by
-    element shape and the output fields container has elshape label.
+    """Transforms an Elemental Nodal or Nodal field into an Elemental field.
+    Each elemental value is the maximum difference between the
+    unaveraged or averaged (depending on the input fields) computed
+    result for all nodes in this element. The result is computed on a
+    given element scoping. If the input fields are mixed shell/solid,
+    and the shell's layers are not specified as collapsed, then the
+    fields are split by element shape and the output fields container
+    has an elshape label.
 
     Parameters
     ----------
     fields_container : FieldsContainer
     mesh : MeshedRegion or MeshesContainer, optional
         The mesh region in this pin is used to
-        perform the averaging, if there is no
-        field's support it is used
+        perform the averaging, used if there
+        is no fields support.
     scoping : Scoping or ScopingsContainer, optional
-        Average only on these elements, if it is
+        Average only on these elements. if it is
         scoping container, the label must
         correspond to the one of the fields
-        container
+        container.
     collapse_shell_layers : bool, optional
-        The max elemental difference is taken through
-        the different shell layers if true
-        (default is false)
+        The maximum elemental difference is taken
+        through the different shell layers if
+        true (default is false).
 
 
     Examples
@@ -89,14 +90,15 @@ def __init__(
 
     @staticmethod
     def _spec():
-        description = """Transform ElementalNodal or Nodal field into Elemental field. Each
-            elemental value is the maximum difference between the
+        description = """Transforms an Elemental Nodal or Nodal field into an Elemental field.
+            Each elemental value is the maximum difference between the
             unaveraged or averaged (depending on the input fields)
-            computed result for all nodes in this element. Result is
-            computed on a given element scoping. If the input fields
-            are mixed shell/solid and the shells layers are not asked
-            to be collapsed, then the fields are split by element
-            shape and the output fields container has elshape label."""
+            computed result for all nodes in this element. The result
+            is computed on a given element scoping. If the input
+            fields are mixed shell/solid, and the shell's layers are
+            not specified as collapsed, then the fields are split by
+            element shape and the output fields container has an
+            elshape label."""
         spec = Specification(
             description=description,
             map_input_pin_spec={
@@ -111,25 +113,25 @@ def _spec():
                     type_names=["abstract_meshed_region", "meshes_container"],
                     optional=True,
                     document="""The mesh region in this pin is used to
-        perform the averaging, if there is no
-        field's support it is used""",
+        perform the averaging, used if there
+        is no fields support.""",
                 ),
                 3: PinSpecification(
                     name="scoping",
                     type_names=["scoping", "scopings_container"],
                     optional=True,
-                    document="""Average only on these elements, if it is
+                    document="""Average only on these elements. if it is
         scoping container, the label must
         correspond to the one of the fields
-        container""",
+        container.""",
                 ),
                 10: PinSpecification(
                     name="collapse_shell_layers",
                     type_names=["bool"],
                     optional=True,
-                    document="""The max elemental difference is taken through
-        the different shell layers if true
-        (default is false)""",
+                    document="""The maximum elemental difference is taken
+        through the different shell layers if
+        true (default is false).""",
                 ),
             },
             map_output_pin_spec={
@@ -236,8 +238,8 @@ def mesh(self):
         """Allows to connect mesh input to the operator.
 
         The mesh region in this pin is used to
-        perform the averaging, if there is no
-        field's support it is used
+        perform the averaging, used if there
+        is no fields support.
 
         Parameters
         ----------
@@ -257,10 +259,10 @@ def mesh(self):
     def scoping(self):
         """Allows to connect scoping input to the operator.
 
-        Average only on these elements, if it is
+        Average only on these elements. if it is
         scoping container, the label must
         correspond to the one of the fields
-        container
+        container.
 
         Parameters
         ----------
@@ -280,9 +282,9 @@ def scoping(self):
     def collapse_shell_layers(self):
         """Allows to connect collapse_shell_layers input to the operator.
 
-        The max elemental difference is taken through
-        the different shell layers if true
-        (default is false)
+        The maximum elemental difference is taken
+        through the different shell layers if
+        true (default is false).
 
         Parameters
         ----------

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

@@ -11,31 +11,33 @@
 
 
 class elemental_fraction_fc(Operator):
-    """Transform ElementalNodal fields into Elemental fields. Each elemental
-    value is the fraction between the elemental difference and the
-    entity average. Result is computed on a given elements scoping.
+    """Transforms Elemental Nodal fields into Elemental fields. Each
+    elemental value is the fraction between the elemental difference
+    and the entity average. The result is computed on a given
+    element's scoping.
 
     Parameters
     ----------
     fields_container : FieldsContainer
     mesh : MeshedRegion, optional
         The mesh region in this pin is used to
-        perform the averaging, if there is no
-        field's support it is used
+        perform the averaging. it is used if
+        there is no fields support.
     scoping : Scoping, optional
-        Average only on these elements, if it is
+        Average only on these elements. if it is a
         scoping container, the label must
         correspond to the one of the fields
-        container
+        containers.
     denominator : FieldsContainer, optional
         If a fields container is set in this pin, it
         is used as the denominator of the
-        fraction instead of entity_average_fc
+        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)
+        (default is false).
 
 
     Examples
@@ -96,10 +98,10 @@ def __init__(
 
     @staticmethod
     def _spec():
-        description = """Transform ElementalNodal fields into Elemental fields. Each elemental
-            value is the fraction between the elemental difference and
-            the entity average. Result is computed on a given elements
-            scoping."""
+        description = """Transforms Elemental Nodal fields into Elemental fields. Each
+            elemental value is the fraction between the elemental
+            difference and the entity average. The result is computed
+            on a given element's scoping."""
         spec = Specification(
             description=description,
             map_input_pin_spec={
@@ -114,25 +116,26 @@ def _spec():
                     type_names=["abstract_meshed_region"],
                     optional=True,
                     document="""The mesh region in this pin is used to
-        perform the averaging, if there is no
-        field's support it is used""",
+        perform the averaging. it is used if
+        there is no fields support.""",
                 ),
                 3: PinSpecification(
                     name="scoping",
                     type_names=["scoping"],
                     optional=True,
-                    document="""Average only on these elements, if it is
+                    document="""Average only on these elements. if it is a
         scoping container, the label must
         correspond to the one of the fields
-        container""",
+        containers.""",
                 ),
                 6: PinSpecification(
                     name="denominator",
                     type_names=["fields_container"],
                     optional=True,
                     document="""If a fields container is set in this pin, it
         is used as the denominator of the
-        fraction instead of entity_average_fc""",
+        fraction instead of
+        entity_average_fc.""",
                 ),
                 10: PinSpecification(
                     name="collapse_shell_layers",
@@ -141,7 +144,7 @@ def _spec():
                     document="""The elemental difference and the entity
         average are taken through the
         different shell layers if true
-        (default is false)""",
+        (default is false).""",
                 ),
             },
             map_output_pin_spec={
@@ -252,8 +255,8 @@ def mesh(self):
         """Allows to connect mesh input to the operator.
 
         The mesh region in this pin is used to
-        perform the averaging, if there is no
-        field's support it is used
+        perform the averaging. it is used if
+        there is no fields support.
 
         Parameters
         ----------
@@ -273,10 +276,10 @@ def mesh(self):
     def scoping(self):
         """Allows to connect scoping input to the operator.
 
-        Average only on these elements, if it is
+        Average only on these elements. if it is a
         scoping container, the label must
         correspond to the one of the fields
-        container
+        containers.
 
         Parameters
         ----------
@@ -298,7 +301,8 @@ def denominator(self):
 
         If a fields container is set in this pin, it
         is used as the denominator of the
-        fraction instead of entity_average_fc
+        fraction instead of
+        entity_average_fc.
 
         Parameters
         ----------
@@ -321,7 +325,7 @@ def collapse_shell_layers(self):
         The elemental difference and the entity
         average are taken through the
         different shell layers if true
-        (default is false)
+        (default is false).
 
         Parameters
         ----------