Skip to content

Commit 49285c4

Browse files
Update generated code for DPF 261_daily on main (#2843)
Co-authored-by: PProfizi <100710998+PProfizi@users.noreply.github.com>
1 parent d1fd4e5 commit 49285c4

File tree

8 files changed

+37
-43
lines changed

8 files changed

+37
-43
lines changed

doc/source/_static/dpf_operators.html

Lines changed: 13 additions & 13 deletions
Large diffs are not rendered by default.

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ class force_summation(Operator):
2828
r"""Computes the sum of elemental forces contribution on a set of nodes in
2929
Global Coordinate System. Equivalent to MAPDL FSUM & NFORCE commands.
3030
Supports Static, Transient, Modal & Harmonic analysis for thermal and
31-
structural degrees of freedom.
31+
structural degrees of freedom. The moment is computed in the unit system
32+
of the data source.
3233
3334
3435
Inputs
@@ -46,7 +47,7 @@ class force_summation(Operator):
4647
force_type: int, optional
4748
Type of force to be processed (0: Total forces (static, damping, and inertia)., 1 (default): Static forces, 2: Damping forces, 3: Inertia forces)
4849
spoint: Field or FieldsContainer, optional
49-
Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0).
50+
Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0). If unitless, it is assumed to be in meters.
5051
scoping_filter: int, optional
5152
Selected set of nodes.
5253
@@ -152,7 +153,8 @@ def _spec() -> Specification:
152153
description = r"""Computes the sum of elemental forces contribution on a set of nodes in
153154
Global Coordinate System. Equivalent to MAPDL FSUM & NFORCE commands.
154155
Supports Static, Transient, Modal & Harmonic analysis for thermal and
155-
structural degrees of freedom.
156+
structural degrees of freedom. The moment is computed in the unit system
157+
of the data source.
156158
"""
157159
spec = Specification(
158160
description=description,
@@ -197,7 +199,7 @@ def _spec() -> Specification:
197199
name="spoint",
198200
type_names=["field", "fields_container"],
199201
optional=True,
200-
document=r"""Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0).""",
202+
document=r"""Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0). If unitless, it is assumed to be in meters.""",
201203
),
202204
9: PinSpecification(
203205
name="scoping_filter",
@@ -487,7 +489,7 @@ def force_type(self) -> Input[int]:
487489
def spoint(self) -> Input[Field | FieldsContainer]:
488490
r"""Allows to connect spoint input to the operator.
489491
490-
Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0).
492+
Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0). If unitless, it is assumed to be in meters.
491493
492494
Returns
493495
-------

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@
2727
class force_summation_psd(Operator):
2828
r"""Computes the sum of elemental forces contribution on a set of nodes in
2929
Global Coordinate System for a PSD analysis. Equivalent to MAPDL
30-
FSUM/NFORCE.
30+
FSUM/NFORCE. The moment is computed in the unit system of the data
31+
source.
3132
3233
3334
Inputs
@@ -41,7 +42,7 @@ class force_summation_psd(Operator):
4142
data_sources: DataSources
4243
Data sources containing RST and PSD files (optional if using a streams container). The operator supports both a single RST file (containing both modal and PSD results) and two separate RST files (one for modal and one for PSD analyses).The data source containing modal results must be defined as an upstream data source.If using a single RST file for PSD and modal analysis, the RST file must be in an upstream data source.If using two separate RST files, only the modal RST must be in an upstream data source.
4344
spoint: Field or FieldsContainer, optional
44-
Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0).
45+
Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0). If unitless, it is assumed to be in meters.
4546
abs_rel_key: int, optional
4647
Key to select the type of response: 0 for relative response (default) or 1 for absolute response.
4748
signif: float, optional
@@ -137,7 +138,8 @@ def __init__(
137138
def _spec() -> Specification:
138139
description = r"""Computes the sum of elemental forces contribution on a set of nodes in
139140
Global Coordinate System for a PSD analysis. Equivalent to MAPDL
140-
FSUM/NFORCE.
141+
FSUM/NFORCE. The moment is computed in the unit system of the data
142+
source.
141143
"""
142144
spec = Specification(
143145
description=description,
@@ -170,7 +172,7 @@ def _spec() -> Specification:
170172
name="spoint",
171173
type_names=["field", "fields_container"],
172174
optional=True,
173-
document=r"""Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0).""",
175+
document=r"""Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0). If unitless, it is assumed to be in meters.""",
174176
),
175177
7: PinSpecification(
176178
name="abs_rel_key",
@@ -401,7 +403,7 @@ def data_sources(self) -> Input[DataSources]:
401403
def spoint(self) -> Input[Field | FieldsContainer]:
402404
r"""Allows to connect spoint input to the operator.
403405
404-
Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0).
406+
Field or fields container of the coordinates of the point used for moment summations. Defaults to (0,0,0). If unitless, it is assumed to be in meters.
405407
406408
Returns
407409
-------

src/ansys/dpf/core/operators/result/torque.py

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,16 @@
2121

2222

2323
class torque(Operator):
24-
r"""Compute torque of a force based on a 3D point.
24+
r"""Compute torque of a force based on a 3D point. The torque is computed in
25+
units consistent with the force and the mesh support.
2526
2627
2728
Inputs
2829
------
2930
fields_container: FieldsContainer
30-
Fields container containing the nodal forces.
31+
Fields container containing the nodal forces. The fields must have an associated mesh support.
3132
spoint: Field or FieldsContainer
32-
Field or fields container containing the summation points for each associated field on pin 0.
33+
Field or fields container containing the summation points for each associated field on pin 0. If unitless, it is assumed to be in meters.
3334
3435
Outputs
3536
-------
@@ -87,7 +88,8 @@ def __init__(
8788

8889
@staticmethod
8990
def _spec() -> Specification:
90-
description = r"""Compute torque of a force based on a 3D point.
91+
description = r"""Compute torque of a force based on a 3D point. The torque is computed in
92+
units consistent with the force and the mesh support.
9193
"""
9294
spec = Specification(
9395
description=description,
@@ -96,13 +98,13 @@ def _spec() -> Specification:
9698
name="fields_container",
9799
type_names=["fields_container"],
98100
optional=False,
99-
document=r"""Fields container containing the nodal forces.""",
101+
document=r"""Fields container containing the nodal forces. The fields must have an associated mesh support.""",
100102
),
101103
1: PinSpecification(
102104
name="spoint",
103105
type_names=["field", "fields_container"],
104106
optional=False,
105-
document=r"""Field or fields container containing the summation points for each associated field on pin 0.""",
107+
document=r"""Field or fields container containing the summation points for each associated field on pin 0. If unitless, it is assumed to be in meters.""",
106108
aliases=["field"],
107109
),
108110
},
@@ -190,7 +192,7 @@ def __init__(self, op: Operator):
190192
def fields_container(self) -> Input[FieldsContainer]:
191193
r"""Allows to connect fields_container input to the operator.
192194
193-
Fields container containing the nodal forces.
195+
Fields container containing the nodal forces. The fields must have an associated mesh support.
194196
195197
Returns
196198
-------
@@ -211,7 +213,7 @@ def fields_container(self) -> Input[FieldsContainer]:
211213
def spoint(self) -> Input[Field | FieldsContainer]:
212214
r"""Allows to connect spoint input to the operator.
213215
214-
Field or fields container containing the summation points for each associated field on pin 0.
216+
Field or fields container containing the summation points for each associated field on pin 0. If unitless, it is assumed to be in meters.
215217
216218
Returns
217219
-------

src/ansys/dpf/core/operators/scoping/adapt_with_scopings_container.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -118,12 +118,6 @@ def _spec() -> Specification:
118118
optional=True,
119119
document=r"""Whether to keep fields that become empty after rescoping. Default is false.""",
120120
),
121-
2: PinSpecification(
122-
name="keep_empty_fields",
123-
type_names=["bool"],
124-
optional=True,
125-
document=r"""Default false.""",
126-
),
127121
},
128122
map_output_pin_spec={
129123
0: PinSpecification(

src/ansys/dpf/core/operators/utility/ints_to_scoping.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,12 +121,6 @@ def _spec() -> Specification:
121121
optional=True,
122122
document=r"""Upper bound for creating a range scoping. Creates IDs from pin 0 value to this upper bound (inclusive)""",
123123
),
124-
2: PinSpecification(
125-
name="upper_bound",
126-
type_names=["int32", "scoping"],
127-
optional=True,
128-
document=r"""Define the upper bound to create a scoping that will contain a range from the single value input in pin 0 to the upper bound defined in this pin.""",
129-
),
130124
},
131125
map_output_pin_spec={
132126
0: PinSpecification(
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)