update operators

Author: PProfizi

docs/source/_static/dpf_operators.html

@@ -18,9 +18,8 @@ class filtering_max_over_time(Operator):
     ----------
     invariant_fc_operator : str
         Name of the invariant operator to be used to
-        calculate filter (avalailable:
-        eqv_fc, invariants_deriv_fc,
-        invariants_fc).
+        calculate filter (available: eqv_fc,
+        invariants_deriv_fc, invariants_fc).
     output_pin : int, optional
         Output pin of the invariant operator. default
         = 0.
@@ -94,9 +93,8 @@ def _spec():
                     type_names=["string"],
                     optional=False,
                     document="""Name of the invariant operator to be used to
-        calculate filter (avalailable:
-        eqv_fc, invariants_deriv_fc,
-        invariants_fc).""",
+        calculate filter (available: eqv_fc,
+        invariants_deriv_fc, invariants_fc).""",
                 ),
                 1: PinSpecification(
                     name="output_pin",
@@ -208,9 +206,8 @@ def invariant_fc_operator(self):
         """Allows to connect invariant_fc_operator input to the operator.
 
         Name of the invariant operator to be used to
-        calculate filter (avalailable:
-        eqv_fc, invariants_deriv_fc,
-        invariants_fc).
+        calculate filter (available: eqv_fc,
+        invariants_deriv_fc, invariants_fc).
 
         Parameters
         ----------

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

@@ -11,8 +11,11 @@
 
 
 class element_nodal_contribution(Operator):
-    """Compute the fraction of the volume attributed to each node of each
-    element.
+    """Compute the fraction of the element measure attributed to each node of
+    each element (fraction of the volume for 3D elements, fraction of
+    the area for 2D elements or fraction of the length for 1D
+    elements). It is computed by taking the integral of the shape
+    function associated to each node within each element.
 
     Parameters
     ----------
@@ -21,10 +24,10 @@ class element_nodal_contribution(Operator):
         Integrate the input field over a specific
         scoping.
     volume_fraction : bool, optional
-        If true, returns influence volume. if false,
-        returns the influence volume fraction
-        (for example, the integrated value of
-        shape function for each node).
+        If true, returns influence volume, area or
+        length. if false, the values are
+        normalized with the element volume,
+        area or length. default: true.
 
 
     Examples
@@ -70,8 +73,12 @@ def __init__(
 
     @staticmethod
     def _spec():
-        description = """Compute the fraction of the volume attributed to each node of each
-            element."""
+        description = """Compute the fraction of the element measure attributed to each node of
+            each element (fraction of the volume for 3D elements,
+            fraction of the area for 2D elements or fraction of the
+            length for 1D elements). It is computed by taking the
+            integral of the shape function associated to each node
+            within each element."""
         spec = Specification(
             description=description,
             map_input_pin_spec={
@@ -92,10 +99,10 @@ def _spec():
                     name="volume_fraction",
                     type_names=["bool"],
                     optional=True,
-                    document="""If true, returns influence volume. if false,
-        returns the influence volume fraction
-        (for example, the integrated value of
-        shape function for each node).""",
+                    document="""If true, returns influence volume, area or
+        length. if false, the values are
+        normalized with the element volume,
+        area or length. default: true.""",
                 ),
             },
             map_output_pin_spec={
@@ -220,10 +227,10 @@ def scoping(self):
     def volume_fraction(self):
         """Allows to connect volume_fraction input to the operator.
 
-        If true, returns influence volume. if false,
-        returns the influence volume fraction
-        (for example, the integrated value of
-        shape function for each node).
+        If true, returns influence volume, area or
+        length. if false, the values are
+        normalized with the element volume,
+        area or length. default: true.
 
         Parameters
         ----------

src/ansys/dpf/core/operators/geo/element_nodal_contribution.py

@@ -20,8 +20,8 @@ class integrate_over_elements(Operator):
         Integrate the input field over a specific
         scoping.
     mesh : MeshedRegion, optional
-        Mesh to integrate on, if not provided the one
-        from input field is provided.
+        Mesh to integrate on. if not provided, the
+        one from input field is employed.
 
 
     Examples
@@ -84,8 +84,8 @@ def _spec():
                     name="mesh",
                     type_names=["abstract_meshed_region"],
                     optional=True,
-                    document="""Mesh to integrate on, if not provided the one
-        from input field is provided.""",
+                    document="""Mesh to integrate on. if not provided, the
+        one from input field is employed.""",
                 ),
             },
             map_output_pin_spec={
@@ -204,8 +204,8 @@ def scoping(self):
     def mesh(self):
         """Allows to connect mesh input to the operator.
 
-        Mesh to integrate on, if not provided the one
-        from input field is provided.
+        Mesh to integrate on. if not provided, the
+        one from input field is employed.
 
         Parameters
         ----------

src/ansys/dpf/core/operators/geo/integrate_over_elements.py

@@ -6,9 +6,9 @@
 from .component_transformer_fc import component_transformer_fc 
 from .descending_sort import descending_sort 
 from .descending_sort_fc import descending_sort_fc 
+from .elementary_data_selector import elementary_data_selector 
+from .elementary_data_selector_fc import elementary_data_selector_fc 
 from .enrich_materials import enrich_materials 
-from .entity_selector import entity_selector 
-from .entity_selector_fc import entity_selector_fc 
 from .identical_fc import identical_fc 
 from .identical_fields import identical_fields 
 from .identical_meshes import identical_meshes