Add the Returns section to the operator automatic docstring (#1823)

* Add the Returns section to the operator automatic docstring Signed-off-by: paul.profizi <[email protected]> * update generated code (#1824) Co-authored-by: PProfizi <[email protected]> --------- Signed-off-by: paul.profizi <[email protected]> Co-authored-by: PyAnsys CI Bot <[email protected]> Co-authored-by: PProfizi <[email protected]>
ansys · Oct 25, 2024 · bdca119 · bdca119
1 parent aa61495
commit bdca119
Show file tree

Hide file tree

Showing 724 changed files with 2,858 additions and 0 deletions.
diff --git a/src/ansys/dpf/core/operators/averaging/elemental_difference.py b/src/ansys/dpf/core/operators/averaging/elemental_difference.py
@@ -30,6 +30,9 @@ class elemental_difference(Operator):
         through the different shell layers if
         true (default is false).
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/elemental_difference_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_difference_fc.py
@@ -38,6 +38,9 @@ class elemental_difference_fc(Operator):
         through the different shell layers if
         true (default is false).
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/elemental_fraction_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_fraction_fc.py
@@ -40,6 +40,9 @@ class elemental_fraction_fc(Operator):
         different shell layers if true
         (default is false).
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/elemental_mean.py b/src/ansys/dpf/core/operators/averaging/elemental_mean.py
@@ -29,6 +29,9 @@ class elemental_mean(Operator):
         correspond to the one of the fields
         containers.
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/elemental_mean_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_mean_fc.py
@@ -36,6 +36,9 @@ class elemental_mean_fc(Operator):
         perform the averaging. it is used if
         there is no fields support.
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal.py b/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal.py
@@ -36,6 +36,13 @@ class elemental_nodal_to_nodal(Operator):
         available). default is false.
     mesh : MeshedRegion, optional
 
+    Returns
+    -------
+    field : Field
+    weight : PropertyField
+        Provides the number of times it was found in
+        the elemental nodal field, for each
+        node. can be used to average later.
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental.py b/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental.py
@@ -22,6 +22,9 @@ class elemental_nodal_to_nodal_elemental(Operator):
         is expected
     mesh_scoping : Scoping, optional
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_elemental_fc.py
@@ -20,6 +20,9 @@ class elemental_nodal_to_nodal_elemental_fc(Operator):
     fields_container : FieldsContainer
     mesh_scoping : Scoping, optional
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_nodal_to_nodal_fc.py
@@ -52,6 +52,14 @@ class elemental_nodal_to_nodal_fc(Operator):
         one field all solids and shells (only
         on one layer).
 
+    Returns
+    -------
+    fields_container : FieldsContainer
+    weights : Class Dataprocessing::Dpftypecollection&lt;Class
+        Dataprocessing::Cpropertyfield&gt;
+        Gives for each node, the number of times it
+        was found in the elemental nodal
+        field. can be used to average later.
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal.py b/src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal.py
@@ -23,6 +23,9 @@ class elemental_to_elemental_nodal(Operator):
         Average only on these entities
     mesh : MeshedRegion, optional
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_to_elemental_nodal_fc.py
@@ -20,6 +20,9 @@ class elemental_to_elemental_nodal_fc(Operator):
     mesh : MeshedRegion, optional
     mesh_scoping : Scoping, optional
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/elemental_to_nodal.py b/src/ansys/dpf/core/operators/averaging/elemental_to_nodal.py
@@ -40,6 +40,9 @@ class elemental_to_nodal(Operator):
         (default is chosen based on the type
         of mesh).
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/elemental_to_nodal_fc.py b/src/ansys/dpf/core/operators/averaging/elemental_to_nodal_fc.py
@@ -39,6 +39,9 @@ class elemental_to_nodal_fc(Operator):
         (default is chosen based on the type
         of mesh).
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes.py b/src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes.py
@@ -22,6 +22,9 @@ class extend_to_mid_nodes(Operator):
         is expected
     mesh : MeshedRegion, optional
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes_fc.py b/src/ansys/dpf/core/operators/averaging/extend_to_mid_nodes_fc.py
@@ -23,6 +23,9 @@ class extend_to_mid_nodes_fc(Operator):
         perform the averaging. it is used if
         there is no fields support.
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/force_summation.py b/src/ansys/dpf/core/operators/averaging/force_summation.py
@@ -39,6 +39,14 @@ class force_summation(Operator):
         Coordinate field of a point for moment
         summations. defaults to (0,0,0).
 
+    Returns
+    -------
+    force_accumulation : FieldsContainer
+    moment_accumulation : FieldsContainer
+    heat_accumulation : FieldsContainer
+    forces_on_nodes : FieldsContainer
+    moments_on_nodes : FieldsContainer
+    heats_on_nodes : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/gauss_to_node_fc.py b/src/ansys/dpf/core/operators/averaging/gauss_to_node_fc.py
@@ -31,6 +31,9 @@ class gauss_to_node_fc(Operator):
         container, the label must correspond
         to the one of the fields containers.
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/nodal_difference.py b/src/ansys/dpf/core/operators/averaging/nodal_difference.py
@@ -26,6 +26,9 @@ class nodal_difference(Operator):
         Average only on these entities
     mesh : MeshedRegion, optional
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/nodal_difference_fc.py b/src/ansys/dpf/core/operators/averaging/nodal_difference_fc.py
@@ -32,6 +32,9 @@ class nodal_difference_fc(Operator):
         correspond to the one of the fields
         containers.
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/nodal_extend_to_mid_nodes.py b/src/ansys/dpf/core/operators/averaging/nodal_extend_to_mid_nodes.py
@@ -27,6 +27,9 @@ class nodal_extend_to_mid_nodes(Operator):
         (improves performances).
     mesh : MeshedRegion, optional
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/nodal_fraction_fc.py b/src/ansys/dpf/core/operators/averaging/nodal_fraction_fc.py
@@ -34,6 +34,9 @@ class nodal_fraction_fc(Operator):
         fraction instead of
         elemental_nodal_to_nodal_fc.
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/nodal_to_elemental.py b/src/ansys/dpf/core/operators/averaging/nodal_to_elemental.py
@@ -25,6 +25,9 @@ class nodal_to_elemental(Operator):
         If true, shell layers are averaged as well
         (default is false).
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_fc.py b/src/ansys/dpf/core/operators/averaging/nodal_to_elemental_fc.py
@@ -44,6 +44,9 @@ class nodal_to_elemental_fc(Operator):
         one field all solids and shells (only
         on one layer).
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/to_elemental_fc.py b/src/ansys/dpf/core/operators/averaging/to_elemental_fc.py
@@ -39,6 +39,9 @@ class to_elemental_fc(Operator):
         one field all solids and shells (only
         on one layer).
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/to_elemental_nodal_fc.py b/src/ansys/dpf/core/operators/averaging/to_elemental_nodal_fc.py
@@ -21,6 +21,9 @@ class to_elemental_nodal_fc(Operator):
     mesh_scoping : Scoping, optional
     mesh : MeshedRegion, optional
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/to_nodal.py b/src/ansys/dpf/core/operators/averaging/to_nodal.py
@@ -32,6 +32,9 @@ class to_nodal(Operator):
         one field all solids and shells (only
         on one layer).
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/averaging/to_nodal_fc.py b/src/ansys/dpf/core/operators/averaging/to_nodal_fc.py
@@ -31,6 +31,9 @@ class to_nodal_fc(Operator):
         one field all solids and shells (only
         on one layer).
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/compression/apply_svd.py b/src/ansys/dpf/core/operators/compression/apply_svd.py
@@ -32,6 +32,24 @@ class apply_svd(Operator):
         transposed (square matrix), default
         value is false
 
+    Returns
+    -------
+    us_svd : FieldsContainer
+        The output entity is a field container (time
+        dependant); it contains the
+        multiplication of two matrices, u and
+        s, where a=u.s.vt
+    vt_svd : FieldsContainer
+        The output entity is a field container (space
+        dependant), containing the vt, where
+        a=u.s.vt
+    sigma : Field or FieldsContainer
+        The output entity is a field (or a field
+        container if input fc contains
+        several labels, where field contains
+        results per label), containing
+        singular (s) values of the input
+        data, where a=u.s.vt
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/compression/apply_zfp.py b/src/ansys/dpf/core/operators/compression/apply_zfp.py
@@ -47,6 +47,28 @@ class apply_zfp(Operator):
         * relativetol) are considered
         identical (default value: 1.0e-10).
 
+    Returns
+    -------
+    compress_speed : float
+        The output entity is a double, containing
+        compression speed of the input data:
+        for elementalnodal location -
+        [elements/sec], for nodal location -
+        [nodes/sec]
+    compress_ratio : float
+        The output entity is a double, containing
+        compression rate = initial/compressed
+    dataOut : CustomTypeFieldsContainer
+        The output entity is a 'custom type field
+        container';                     each
+        output field containing compressed
+        results corresponding to one
+        component data (ie. input vector
+        field/fc contains 3 components will
+        give 3 output fields), this is not
+        the case when input pin3 is set to 3,
+        all components will be compressed
+        into one field.
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/compression/kmeans_clustering.py b/src/ansys/dpf/core/operators/compression/kmeans_clustering.py
@@ -30,6 +30,12 @@ class kmeans_clustering(Operator):
         '0' for x-displacement, '1' for
         y-displacement,...
 
+    Returns
+    -------
+    scoping_clusters : ScopingsContainer
+        Scopings container with the space scoping
+        (entities' ids) corresponding to each
+        of k-clusters
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/compression/zfp_decompress.py b/src/ansys/dpf/core/operators/compression/zfp_decompress.py
@@ -23,6 +23,15 @@ class zfp_decompress(Operator):
         zfp_compression operator to
         decompress
 
+    Returns
+    -------
+    dataOut : Field or FieldsContainer
+        The output entity is a field or a fields
+        container; it contains decompressed
+        data
+    decompress_speed : float
+        The output entity is a double, containing
+        decompression speed (mb/sec)
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/filter/abc_weightings.py b/src/ansys/dpf/core/operators/filter/abc_weightings.py
@@ -29,6 +29,10 @@ class abc_weightings(Operator):
         time freq scoping and not by ids.
         default is false
 
+    Returns
+    -------
+    weightings : FieldsContainer
+        Weighted data in db units.
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/filter/field_band_pass.py b/src/ansys/dpf/core/operators/filter/field_band_pass.py
@@ -28,6 +28,9 @@ class field_band_pass(Operator):
         A maximum threshold scalar or a field
         containing one value is expected.
 
+    Returns
+    -------
+    field : Field
 
     Examples
     --------

diff --git a/src/ansys/dpf/core/operators/filter/field_band_pass_fc.py b/src/ansys/dpf/core/operators/filter/field_band_pass_fc.py
@@ -28,6 +28,9 @@ class field_band_pass_fc(Operator):
         A maximum threshold scalar or a field
         containing one value is expected.
 
+    Returns
+    -------
+    fields_container : FieldsContainer
 
     Examples
     --------