update operators (#889)

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

(cherry picked from commit c8ee4f3)

Author: github-actions[bot]

docs/source/_static/dpf_operators.html

@@ -19,9 +19,10 @@ class accumulate(Operator):
     fieldA : Field or FieldsContainer
         Field or fields container with only one field
         is expected
-    ponderation : Field
-        Field
-    time_scoping : Scoping
+    ponderation : Field, optional
+        Field containing weights, one weight per
+        entity
+    time_scoping : Scoping, optional
         Time_scoping
 
 
@@ -81,13 +82,14 @@ def _spec():
                 1: PinSpecification(
                     name="ponderation",
                     type_names=["field"],
-                    optional=False,
-                    document="""Field""",
+                    optional=True,
+                    document="""Field containing weights, one weight per
+        entity""",
                 ),
                 2: PinSpecification(
                     name="time_scoping",
                     type_names=["scoping"],
-                    optional=False,
+                    optional=True,
                     document="""Time_scoping""",
                 ),
             },
@@ -96,7 +98,8 @@ def _spec():
                     name="field",
                     type_names=["field"],
                     optional=False,
-                    document="""""",
+                    document="""Field containing the (weighted) sum for each
+        component in an elementary data""",
                 ),
             },
         )
@@ -189,7 +192,8 @@ def fieldA(self):
     def ponderation(self):
         """Allows to connect ponderation input to the operator.
 
-        Field
+        Field containing weights, one weight per
+        entity
 
         Parameters
         ----------

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

@@ -19,9 +19,10 @@ class accumulate_fc(Operator):
     fields_container : FieldsContainer
         Field or fields container with only one field
         is expected
-    ponderation : Field
-        Field
-    time_scoping : Scoping
+    ponderation : Field, optional
+        Field containing weights, one weight per
+        entity
+    time_scoping : Scoping, optional
         Time_scoping
 
 
@@ -86,13 +87,14 @@ def _spec():
                 1: PinSpecification(
                     name="ponderation",
                     type_names=["field"],
-                    optional=False,
-                    document="""Field""",
+                    optional=True,
+                    document="""Field containing weights, one weight per
+        entity""",
                 ),
                 2: PinSpecification(
                     name="time_scoping",
                     type_names=["scoping"],
-                    optional=False,
+                    optional=True,
                     document="""Time_scoping""",
                 ),
             },
@@ -101,7 +103,8 @@ def _spec():
                     name="fields_container",
                     type_names=["fields_container"],
                     optional=False,
-                    document="""""",
+                    document="""Field containing the (weighted) sum for each
+        component in an elementary data""",
                 ),
             },
         )
@@ -194,7 +197,8 @@ def fields_container(self):
     def ponderation(self):
         """Allows to connect ponderation input to the operator.
 
-        Field
+        Field containing weights, one weight per
+        entity
 
         Parameters
         ----------