Skip to content

Commit 5dc3f00

Browse files
Update generated code for DPF 261 on fix/operator_classes_docstring_type_hints (#2722)
Co-authored-by: PProfizi <[email protected]>
1 parent a5ffde0 commit 5dc3f00

File tree

780 files changed

+2340
-2340
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

780 files changed

+2340
-2340
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ class elemental_difference(Operator):
2222
element scoping.
2323
2424
25-
Parameters
26-
----------
25+
Inputs
26+
------
2727
field: Field or FieldsContainer
2828
field or fields container with only one field is expected
2929
mesh_scoping: Scoping, optional
@@ -32,7 +32,7 @@ class elemental_difference(Operator):
3232
through_layers: bool, optional
3333
The maximum elemental difference is taken through the different shell layers if true (default is false).
3434
35-
Returns
35+
Outputs
3636
-------
3737
field: Field
3838

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ class elemental_difference_fc(Operator):
2525
the output fields container has an elshape label.
2626
2727
28-
Parameters
29-
----------
28+
Inputs
29+
------
3030
fields_container: FieldsContainer
3131
mesh: MeshedRegion or MeshesContainer, optional
3232
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):
3535
collapse_shell_layers: bool, optional
3636
If true, the data across different shell layers is averaged as well (default is false).
3737
38-
Returns
38+
Outputs
3939
-------
4040
fields_container: FieldsContainer
4141

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ class elemental_fraction_fc(Operator):
2121
average. The result is computed on a given element’s scoping.
2222
2323
24-
Parameters
25-
----------
24+
Inputs
25+
------
2626
fields_container: FieldsContainer
2727
mesh: MeshedRegion, optional
2828
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):
3333
collapse_shell_layers: bool, optional
3434
If true, the data across different shell layers is averaged as well (default is false).
3535
36-
Returns
36+
Outputs
3737
-------
3838
fields_container: FieldsContainer
3939

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ class elemental_mean(Operator):
2020
Elemental), (NodalElemental -> Nodal).
2121
2222
23-
Parameters
24-
----------
23+
Inputs
24+
------
2525
field: Field
2626
collapse_shell_layers: bool, optional
2727
If true, shell layers are averaged as well (default is false).
@@ -30,7 +30,7 @@ class elemental_mean(Operator):
3030
scoping: Scoping, optional
3131
Average only on these elements. If it is a scoping container, the label must correspond to the one of the fields containers.
3232
33-
Returns
33+
Outputs
3434
-------
3535
field: Field
3636

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ class elemental_mean_fc(Operator):
2727
layers are collapsed and shells and solid fields are always merged.
2828
2929
30-
Parameters
31-
----------
30+
Inputs
31+
------
3232
fields_container: FieldsContainer
3333
collapse_shell_layers: bool, optional
3434
If true, the data across different shell layers is averaged as well (default is false).
@@ -43,7 +43,7 @@ class elemental_mean_fc(Operator):
4343
e_shell_layer: int, optional
4444
0: Top, 1: Bottom, 2: TopBottom, 3: Mid, 4: TopBottomMid. This pin only has an effect when collapse_shell_layers is false.
4545
46-
Returns
46+
Outputs
4747
-------
4848
fields_container: FieldsContainer
4949

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ class elemental_nodal_to_nodal(Operator):
2020
averaging process. The result is computed on a given node’s scoping.
2121
2222
23-
Parameters
24-
----------
23+
Inputs
24+
------
2525
field: Field or FieldsContainer
2626
field or fields container with only one field is expected
2727
mesh_scoping: Scoping, optional
@@ -34,7 +34,7 @@ class elemental_nodal_to_nodal(Operator):
3434
Extends weights to mid nodes (when available). Default is false.
3535
mesh: MeshedRegion, optional
3636
37-
Returns
37+
Outputs
3838
-------
3939
field: Field
4040
weight: PropertyField

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ class elemental_nodal_to_nodal_elemental(Operator):
2020
computed on a given node’s scoping.
2121
2222
23-
Parameters
24-
----------
23+
Inputs
24+
------
2525
field: Field or FieldsContainer
2626
field or fields container with only one field is expected
2727
mesh_scoping: Scoping, optional
2828
29-
Returns
29+
Outputs
3030
-------
3131
field: Field
3232

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ class elemental_nodal_to_nodal_elemental_fc(Operator):
2020
is computed on a given node’s scoping.
2121
2222
23-
Parameters
24-
----------
23+
Inputs
24+
------
2525
fields_container: FieldsContainer
2626
mesh_scoping: Scoping, optional
2727
28-
Returns
28+
Outputs
2929
-------
3030
fields_container: FieldsContainer
3131

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ class elemental_nodal_to_nodal_fc(Operator):
2323
merge_solid_shell input.
2424
2525
26-
Parameters
27-
----------
26+
Inputs
27+
------
2828
fields_container: FieldsContainer
2929
mesh: MeshedRegion or MeshesContainer, optional
3030
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):
4141
shell_layer: int, optional
4242
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).
4343
44-
Returns
44+
Outputs
4545
-------
4646
fields_container: FieldsContainer
4747
weights: Class Dataprocessing::Dpftypecollection&lt;Class

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ class elemental_to_elemental_nodal(Operator):
1919
r"""Transforms an Elemental field to an Elemental Nodal field.
2020
2121
22-
Parameters
23-
----------
22+
Inputs
23+
------
2424
field: Field or FieldsContainer
2525
field or fields container with only one field is expected
2626
mesh_scoping: Scoping, optional
2727
average only on these entities
2828
mesh: MeshedRegion, optional
2929
30-
Returns
30+
Outputs
3131
-------
3232
field: Field
3333

0 commit comments

Comments
 (0)