Merge branch 'main' of https://github.com/ansys/pydpf-core into oparreno/new_nodal_orientations_fix_pr

Author: oparreno

.github/workflows/ci.yml

@@ -198,11 +198,15 @@ jobs:
       matrix:
         version:
           - ${{ fromJson(vars.ANSYS_VERSIONS_RETRO_WITH_PATCH) }}
-          - ${{ fromJson(vars.ANSYS_VERSION_LAST_RELEASED_WITH_PATCH) }}
+        docstring:
+          - "false"
+        include:
+          - version: ${{ fromJson(vars.ANSYS_VERSION_LAST_RELEASED_WITH_PATCH) }}
+            docstring: "true"
     uses: ./.github/workflows/tests.yml
     with:
       ANSYS_VERSION: ${{ matrix.version.version }}
       python_versions: '["3.10"]'
-      DOCSTRING: false
+      DOCSTRING: ${{ matrix.docstring }}
       standalone_suffix: ${{ matrix.version.patch }}
     secrets: inherit

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

@@ -22,8 +22,8 @@ class elemental_difference(Operator):
     element scoping.
 
 
-    Parameters
-    ----------
+    Inputs
+    ------
     field: Field or FieldsContainer
         field or fields container with only one field is expected
     mesh_scoping: Scoping, optional
@@ -32,7 +32,7 @@ class elemental_difference(Operator):
     through_layers: bool, optional
         The maximum elemental difference is taken through the different shell layers if true (default is false).
 
-    Returns
+    Outputs
     -------
     field: Field
 

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

@@ -25,8 +25,8 @@ class elemental_difference_fc(Operator):
     the output fields container has an elshape label.
 
 
-    Parameters
-    ----------
+    Inputs
+    ------
     fields_container: FieldsContainer
     mesh: MeshedRegion or MeshesContainer, optional
         The mesh region in this pin is used to perform the averaging, used if there is no fields support.
@@ -35,7 +35,7 @@ class elemental_difference_fc(Operator):
     collapse_shell_layers: bool, optional
         If true, the data across different shell layers is averaged as well (default is false).
 
-    Returns
+    Outputs
     -------
     fields_container: FieldsContainer
 

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

@@ -21,8 +21,8 @@ class elemental_fraction_fc(Operator):
     average. The result is computed on a given element’s scoping.
 
 
-    Parameters
-    ----------
+    Inputs
+    ------
     fields_container: FieldsContainer
     mesh: MeshedRegion, optional
         The mesh region in this pin is used to perform the averaging. It is used if there is no fields support.
@@ -33,7 +33,7 @@ class elemental_fraction_fc(Operator):
     collapse_shell_layers: bool, optional
         If true, the data across different shell layers is averaged as well (default is false).
 
-    Returns
+    Outputs
     -------
     fields_container: FieldsContainer
 

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

@@ -20,8 +20,8 @@ class elemental_mean(Operator):
     Elemental), (NodalElemental -> Nodal).
 
 
-    Parameters
-    ----------
+    Inputs
+    ------
     field: Field
     collapse_shell_layers: bool, optional
         If true, shell layers are averaged as well (default is false).
@@ -30,7 +30,7 @@ class elemental_mean(Operator):
     scoping: Scoping, optional
         Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers.
 
-    Returns
+    Outputs
     -------
     field: Field
 

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

@@ -27,8 +27,8 @@ class elemental_mean_fc(Operator):
     layers are collapsed and shells and solid fields are always merged.
 
 
-    Parameters
-    ----------
+    Inputs
+    ------
     fields_container: FieldsContainer
     collapse_shell_layers: bool, optional
         If true, the data across different shell layers is averaged as well (default is false).
@@ -43,7 +43,7 @@ class elemental_mean_fc(Operator):
     e_shell_layer: int, optional
         0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. This pin only has an effect when collapse_shell_layers is false.
 
-    Returns
+    Outputs
     -------
     fields_container: FieldsContainer
 

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

@@ -20,8 +20,8 @@ class elemental_nodal_to_nodal(Operator):
     averaging process. The result is computed on a given node’s scoping.
 
 
-    Parameters
-    ----------
+    Inputs
+    ------
     field: Field or FieldsContainer
         field or fields container with only one field is expected
     mesh_scoping: Scoping, optional
@@ -34,7 +34,7 @@ class elemental_nodal_to_nodal(Operator):
         Extends weights to mid nodes (when available). Default is false.
     mesh: MeshedRegion, optional
 
-    Returns
+    Outputs
     -------
     field: Field
     weight: PropertyField

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

@@ -20,13 +20,13 @@ class elemental_nodal_to_nodal_elemental(Operator):
     computed on a given node’s scoping.
 
 
-    Parameters
-    ----------
+    Inputs
+    ------
     field: Field or FieldsContainer
         field or fields container with only one field is expected
     mesh_scoping: Scoping, optional
 
-    Returns
+    Outputs
     -------
     field: Field
 

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

@@ -20,12 +20,12 @@ class elemental_nodal_to_nodal_elemental_fc(Operator):
     is computed on a given node’s scoping.
 
 
-    Parameters
-    ----------
+    Inputs
+    ------
     fields_container: FieldsContainer
     mesh_scoping: Scoping, optional
 
-    Returns
+    Outputs
     -------
     fields_container: FieldsContainer
 

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

@@ -23,8 +23,8 @@ class elemental_nodal_to_nodal_fc(Operator):
     merge_solid_shell input.
 
 
-    Parameters
-    ----------
+    Inputs
+    ------
     fields_container: FieldsContainer
     mesh: 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.
@@ -41,7 +41,7 @@ class elemental_nodal_to_nodal_fc(Operator):
     shell_layer: int, optional
         0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. If merge_solid_shell is true, this pin needs to be specified to a value that extracts only one layer (Top, Bottom or Mid).
 
-    Returns
+    Outputs
     -------
     fields_container: FieldsContainer
     weights: Class Dataprocessing::Dpftypecollection<Class